private void _addParamElement(
Element methodElement, JavaParameter javaParameter, DocletTag[] paramDocletTags) {
String name = javaParameter.getName();
String type = javaParameter.getType().getValue();
String value = null;
for (DocletTag paramDocletTag : paramDocletTags) {
String curValue = paramDocletTag.getValue();
if (!curValue.startsWith(name)) {
continue;
} else {
curValue = value;
break;
}
}
Element paramElement = methodElement.addElement("param");
DocUtil.add(paramElement, "name", name);
DocUtil.add(paramElement, "type", type);
if (value != null) {
value = value.substring(name.length());
}
Element commentElement = paramElement.addElement("comment");
commentElement.addCDATA(_getCDATA(value));
}
private void _addDocletElements(
Element parentElement, AbstractJavaEntity abstractJavaEntity, String name) {
DocletTag[] docletTags = abstractJavaEntity.getTagsByName(name);
for (DocletTag docletTag : docletTags) {
String value = docletTag.getValue();
if (name.equals("author")
|| name.equals("see")
|| name.equals("since")
|| name.equals("version")) {
/*if (value.startsWith("Raymond Aug")) {
value = "Raymond Aug\u00c3\u00a9";
}*/
DocUtil.add(parentElement, name, value);
} else {
Element element = parentElement.addElement(name);
element.addCDATA(value);
}
}
}
private void _addThrowsElement(
Element methodElement, Type exception, DocletTag[] throwsDocletTags) {
String name = exception.getJavaClass().getName();
String value = null;
for (DocletTag throwsDocletTag : throwsDocletTags) {
String curValue = throwsDocletTag.getValue();
if (!curValue.startsWith(name)) {
continue;
} else {
curValue = value;
break;
}
}
Element throwsElement = methodElement.addElement("throws");
DocUtil.add(throwsElement, "name", name);
DocUtil.add(throwsElement, "type", exception.getValue());
if (value != null) {
value = value.substring(name.length());
}
Element commentElement = throwsElement.addElement("comment");
commentElement.addCDATA(_getCDATA(value));
}
private void _addReturnElement(Element methodElement, JavaMethod javaMethod) throws Exception {
Type returns = javaMethod.getReturns();
if (returns == null) {
return;
}
String returnsValue = returns.getValue();
if (returnsValue.equals("void")) {
return;
}
Element returnElement = methodElement.addElement("return");
DocletTag[] returnDocletTags = javaMethod.getTagsByName("return");
String comment = StringPool.BLANK;
if (returnDocletTags.length > 0) {
DocletTag returnDocletTag = returnDocletTags[0];
comment = GetterUtil.getString(returnDocletTag.getValue());
DocUtil.add(returnElement, "required", true);
}
comment = _trimMultilineText(comment);
Element commentElement = returnElement.addElement("comment");
commentElement.addCDATA(comment);
}
@Test
public void testGetFieldsFromContentWithDocumentLibraryElement() throws Exception {
Fields expectedFields = new Fields();
ServiceContext serviceContext =
ServiceContextTestUtil.getServiceContext(group.getGroupId(), TestPropsValues.getUserId());
FileEntry fileEntry =
DLAppLocalServiceUtil.addFileEntry(
TestPropsValues.getUserId(),
group.getGroupId(),
DLFolderConstants.DEFAULT_PARENT_FOLDER_ID,
"Test 1.txt",
ContentTypes.TEXT_PLAIN,
RandomTestUtil.randomBytes(),
serviceContext);
Field documentLibraryField = getDocumentLibraryField(fileEntry, _ddmStructure.getStructureId());
expectedFields.put(documentLibraryField);
Field fieldsDisplayField =
getFieldsDisplayField(_ddmStructure.getStructureId(), "document_library_INSTANCE_4aGOvP3N");
expectedFields.put(fieldsDisplayField);
String content = read("test-journal-content-doc-library-field.xml");
XPath xPathSelector = SAXReaderUtil.createXPath("//dynamic-content");
Document document = SAXReaderUtil.read(content);
Element element = (Element) xPathSelector.selectSingleNode(document);
String[] previewURLs = new String[2];
previewURLs[0] =
DLUtil.getPreviewURL(
fileEntry, fileEntry.getFileVersion(), null, StringPool.BLANK, true, true);
previewURLs[1] =
DLUtil.getPreviewURL(
fileEntry, fileEntry.getFileVersion(), null, StringPool.BLANK, false, false);
for (int i = 0; i < previewURLs.length; i++) {
element.addCDATA(previewURLs[i]);
Fields actualFields = JournalConverterUtil.getDDMFields(_ddmStructure, document.asXML());
Assert.assertEquals(expectedFields, actualFields);
}
}
protected void transformDateFieldValue(Element dynamicContentElement) {
String value = dynamicContentElement.getText();
if (!Validator.isNumber(value)) {
return;
}
Date date = new Date(GetterUtil.getLong(value));
dynamicContentElement.clearContent();
dynamicContentElement.addCDATA(_dateFormat.format(date));
}
private void _addFieldElement(Element rootElement, JavaField javaField) {
Element fieldElement = rootElement.addElement("field");
DocUtil.add(fieldElement, "name", javaField.getName());
Element commentElement = fieldElement.addElement("comment");
commentElement.addCDATA(_getCDATA(javaField));
_addDocletElements(fieldElement, javaField, "deprecated");
_addDocletElements(fieldElement, javaField, "see");
_addDocletElements(fieldElement, javaField, "since");
_addDocletElements(fieldElement, javaField, "version");
}
protected void updateField(Element dynamicContentElement, Serializable fieldValue) {
dynamicContentElement.clearContent();
if (fieldValue instanceof Date) {
Date valueDate = (Date) fieldValue;
fieldValue = valueDate.getTime();
}
String valueString = String.valueOf(fieldValue);
dynamicContentElement.addCDATA(valueString.trim());
}
private void _addDocletElements(
Element parentElement, AbstractJavaEntity abstractJavaEntity, String name) throws Exception {
DocletTag[] docletTags = abstractJavaEntity.getTagsByName(name);
for (DocletTag docletTag : docletTags) {
String value = docletTag.getValue();
value = _trimMultilineText(value);
value = StringUtil.replace(value, " </", "</");
Element element = parentElement.addElement(name);
element.addCDATA(value);
}
if ((docletTags.length == 0) && name.equals("author")) {
Element element = parentElement.addElement(name);
element.addCDATA(ServiceBuilder.AUTHOR);
}
}
private void _addClassCommentElement(Element rootElement, JavaClass javaClass) {
String comment = _getCDATA(javaClass);
if (comment.startsWith("Copyright (c)")) {
comment = StringPool.BLANK;
}
if (Validator.isNull(comment)) {
return;
}
Element commentElement = rootElement.addElement("comment");
commentElement.addCDATA(comment);
}
private void _addMethodElement(Element rootElement, JavaMethod javaMethod) {
Element methodElement = rootElement.addElement("method");
DocUtil.add(methodElement, "name", javaMethod.getName());
Element commentElement = methodElement.addElement("comment");
commentElement.addCDATA(_getCDATA(javaMethod));
_addDocletElements(methodElement, javaMethod, "deprecated");
_addParamElements(methodElement, javaMethod);
_addReturnElement(methodElement, javaMethod);
_addDocletElements(methodElement, javaMethod, "see");
_addDocletElements(methodElement, javaMethod, "since");
_addThrowsElements(methodElement, javaMethod);
_addDocletElements(methodElement, javaMethod, "version");
}
protected String convertStaticContentToDynamic(String content) throws Exception {
Document document = SAXReaderUtil.read(content);
Document newDocument = SAXReaderUtil.createDocument();
Element rootElement = document.getRootElement();
String availableLocales = rootElement.attributeValue("available-locales");
String defaultLocale = rootElement.attributeValue("default-locale");
Element newRootElement = SAXReaderUtil.createElement("root");
newRootElement.addAttribute("available-locales", availableLocales);
newRootElement.addAttribute("default-locale", defaultLocale);
newDocument.add(newRootElement);
Element dynamicElementElement = SAXReaderUtil.createElement("dynamic-element");
dynamicElementElement.addAttribute("name", "content");
dynamicElementElement.addAttribute("type", "text_area");
dynamicElementElement.addAttribute("index-type", "keyword");
dynamicElementElement.addAttribute("index", String.valueOf(0));
newRootElement.add(dynamicElementElement);
List<Element> staticContentElements = rootElement.elements("static-content");
for (Element staticContentElement : staticContentElements) {
String languageId = staticContentElement.attributeValue("language-id");
String text = staticContentElement.getText();
Element dynamicContentElement = SAXReaderUtil.createElement("dynamic-content");
dynamicContentElement.addAttribute("language-id", languageId);
dynamicContentElement.addCDATA(text);
dynamicElementElement.add(dynamicContentElement);
}
return XMLUtil.formatXML(newDocument);
}
private void _addFieldElement(Element rootElement, JavaField javaField) throws Exception {
Element fieldElement = rootElement.addElement("field");
DocUtil.add(fieldElement, "name", javaField.getName());
String comment = _getCDATA(javaField);
if (Validator.isNotNull(comment)) {
Element commentElement = fieldElement.addElement("comment");
commentElement.addCDATA(comment);
}
_addDocletElements(fieldElement, javaField, "version");
_addDocletElements(fieldElement, javaField, "see");
_addDocletElements(fieldElement, javaField, "since");
_addDocletElements(fieldElement, javaField, "deprecated");
}
private void _addClassCommentElement(Element rootElement, JavaClass javaClass) {
Element commentElement = rootElement.addElement("comment");
String comment = _getCDATA(javaClass);
if (comment.startsWith("Copyright (c) 2000-2010 Liferay, Inc.")) {
comment = StringPool.BLANK;
}
if (comment.startsWith("<a href=\"" + javaClass.getName() + ".java.html\">")) {
int pos = comment.indexOf("</a>");
comment = comment.substring(pos + 4).trim();
}
commentElement.addCDATA(comment);
}
protected void exportExpandoTables(PortletDataContext portletDataContext) throws Exception {
Document document = SAXReaderUtil.createDocument();
Element rootElement = document.addElement("expando-tables");
Map<String, List<ExpandoColumn>> expandoColumnsMap = portletDataContext.getExpandoColumns();
for (Map.Entry<String, List<ExpandoColumn>> entry : expandoColumnsMap.entrySet()) {
String className = entry.getKey();
Element expandoTableElement = rootElement.addElement("expando-table");
expandoTableElement.addAttribute("class-name", className);
List<ExpandoColumn> expandoColumns = entry.getValue();
for (ExpandoColumn expandoColumn : expandoColumns) {
Element expandoColumnElement = expandoTableElement.addElement("expando-column");
expandoColumnElement.addAttribute("column-id", String.valueOf(expandoColumn.getColumnId()));
expandoColumnElement.addAttribute("name", expandoColumn.getName());
expandoColumnElement.addAttribute("type", String.valueOf(expandoColumn.getType()));
DocUtil.add(expandoColumnElement, "default-data", expandoColumn.getDefaultData());
Element typeSettingsElement = expandoColumnElement.addElement("type-settings");
UnicodeProperties typeSettingsProperties = expandoColumn.getTypeSettingsProperties();
typeSettingsElement.addCDATA(typeSettingsProperties.toString());
}
}
portletDataContext.addZipEntry(
ExportImportPathUtil.getRootPath(portletDataContext) + "/expando-tables.xml",
document.formattedString());
}
private void _addMethodElement(Element rootElement, JavaMethod javaMethod) throws Exception {
Element methodElement = rootElement.addElement("method");
DocUtil.add(methodElement, "name", javaMethod.getName());
String comment = _getCDATA(javaMethod);
if (Validator.isNotNull(comment)) {
Element commentElement = methodElement.addElement("comment");
commentElement.addCDATA(_getCDATA(javaMethod));
}
_addDocletElements(methodElement, javaMethod, "version");
_addParamElements(methodElement, javaMethod);
_addReturnElement(methodElement, javaMethod);
_addThrowsElements(methodElement, javaMethod);
_addDocletElements(methodElement, javaMethod, "see");
_addDocletElements(methodElement, javaMethod, "since");
_addDocletElements(methodElement, javaMethod, "deprecated");
}
protected File doExportLayoutsAsFile(
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String, String[]> parameterMap,
Date startDate,
Date endDate)
throws Exception {
boolean exportCategories = MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.CATEGORIES);
boolean exportIgnoreLastPublishDate =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.IGNORE_LAST_PUBLISH_DATE);
boolean exportPermissions =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.PERMISSIONS);
boolean exportUserPermissions =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.USER_PERMISSIONS);
boolean exportPortletArchivedSetups =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.PORTLET_ARCHIVED_SETUPS);
boolean exportPortletUserPreferences =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.PORTLET_USER_PREFERENCES);
boolean exportTheme = MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.THEME);
boolean exportThemeSettings =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.THEME_REFERENCE);
boolean exportLogo = MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.LOGO);
boolean exportLayoutSetSettings =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.LAYOUT_SET_SETTINGS);
boolean publishToRemote =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.PUBLISH_TO_REMOTE);
boolean updateLastPublishDate =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.UPDATE_LAST_PUBLISH_DATE);
if (_log.isDebugEnabled()) {
_log.debug("Export categories " + exportCategories);
_log.debug("Export permissions " + exportPermissions);
_log.debug("Export user permissions " + exportUserPermissions);
_log.debug("Export portlet archived setups " + exportPortletArchivedSetups);
_log.debug("Export portlet user preferences " + exportPortletUserPreferences);
_log.debug("Export theme " + exportTheme);
}
LayoutSet layoutSet = LayoutSetLocalServiceUtil.getLayoutSet(groupId, privateLayout);
long companyId = layoutSet.getCompanyId();
long defaultUserId = UserLocalServiceUtil.getDefaultUserId(companyId);
ServiceContext serviceContext = ServiceContextThreadLocal.getServiceContext();
if (serviceContext == null) {
serviceContext = new ServiceContext();
serviceContext.setCompanyId(companyId);
serviceContext.setSignedIn(false);
serviceContext.setUserId(defaultUserId);
ServiceContextThreadLocal.pushServiceContext(serviceContext);
}
serviceContext.setAttribute("exporting", Boolean.TRUE);
long layoutSetBranchId = MapUtil.getLong(parameterMap, "layoutSetBranchId");
serviceContext.setAttribute("layoutSetBranchId", layoutSetBranchId);
long lastPublishDate = System.currentTimeMillis();
if (endDate != null) {
lastPublishDate = endDate.getTime();
}
if (exportIgnoreLastPublishDate) {
endDate = null;
startDate = null;
}
StopWatch stopWatch = null;
if (_log.isInfoEnabled()) {
stopWatch = new StopWatch();
stopWatch.start();
}
LayoutCache layoutCache = new LayoutCache();
ZipWriter zipWriter = ZipWriterFactoryUtil.getZipWriter();
PortletDataContext portletDataContext =
new PortletDataContextImpl(
companyId, groupId, parameterMap, new HashSet<String>(), startDate, endDate, zipWriter);
portletDataContext.setPortetDataContextListener(
new PortletDataContextListenerImpl(portletDataContext));
Document document = SAXReaderUtil.createDocument();
Element rootElement = document.addElement("root");
Element headerElement = rootElement.addElement("header");
headerElement.addAttribute("build-number", String.valueOf(ReleaseInfo.getBuildNumber()));
headerElement.addAttribute("export-date", Time.getRFC822());
if (portletDataContext.hasDateRange()) {
headerElement.addAttribute("start-date", String.valueOf(portletDataContext.getStartDate()));
headerElement.addAttribute("end-date", String.valueOf(portletDataContext.getEndDate()));
}
headerElement.addAttribute("group-id", String.valueOf(groupId));
headerElement.addAttribute("private-layout", String.valueOf(privateLayout));
Group group = layoutSet.getGroup();
String type = "layout-set";
if (group.isLayoutSetPrototype()) {
type = "layout-set-prototype";
LayoutSetPrototype layoutSetPrototype =
LayoutSetPrototypeLocalServiceUtil.getLayoutSetPrototype(group.getClassPK());
headerElement.addAttribute("type-uuid", layoutSetPrototype.getUuid());
}
headerElement.addAttribute("type", type);
if (exportTheme || exportThemeSettings) {
headerElement.addAttribute("theme-id", layoutSet.getThemeId());
headerElement.addAttribute("color-scheme-id", layoutSet.getColorSchemeId());
}
if (exportLogo) {
Image image = ImageLocalServiceUtil.getImage(layoutSet.getLogoId());
if (image != null) {
String logoPath = getLayoutSetLogoPath(portletDataContext);
headerElement.addAttribute("logo-path", logoPath);
portletDataContext.addZipEntry(logoPath, image.getTextObj());
}
}
if (exportLayoutSetSettings) {
Element settingsElement = headerElement.addElement("settings");
settingsElement.addCDATA(layoutSet.getSettings());
}
Element cssElement = headerElement.addElement("css");
cssElement.addCDATA(layoutSet.getCss());
Portlet layoutConfigurationPortlet =
PortletLocalServiceUtil.getPortletById(
portletDataContext.getCompanyId(), PortletKeys.LAYOUT_CONFIGURATION);
Map<String, Object[]> portletIds = new LinkedHashMap<String, Object[]>();
List<Layout> layouts = null;
if ((layoutIds == null) || (layoutIds.length == 0)) {
layouts = LayoutLocalServiceUtil.getLayouts(groupId, privateLayout);
} else {
layouts = LayoutLocalServiceUtil.getLayouts(groupId, privateLayout, layoutIds);
}
List<Portlet> portlets = getAlwaysExportablePortlets(companyId);
if (!layouts.isEmpty()) {
Layout firstLayout = layouts.get(0);
if (group.isStagingGroup()) {
group = group.getLiveGroup();
}
for (Portlet portlet : portlets) {
String portletId = portlet.getRootPortletId();
if (!group.isStagedPortlet(portletId)) {
continue;
}
String key = PortletPermissionUtil.getPrimaryKey(0, portletId);
if (portletIds.get(key) == null) {
portletIds.put(
key,
new Object[] {
portletId, firstLayout.getPlid(), groupId, StringPool.BLANK, StringPool.BLANK
});
}
}
}
Element layoutsElement = rootElement.addElement("layouts");
String layoutSetPrototypeUuid = layoutSet.getLayoutSetPrototypeUuid();
if (Validator.isNotNull(layoutSetPrototypeUuid)) {
LayoutSetPrototype layoutSetPrototype =
LayoutSetPrototypeLocalServiceUtil.getLayoutSetPrototypeByUuid(layoutSetPrototypeUuid);
layoutsElement.addAttribute("layout-set-prototype-uuid", layoutSetPrototypeUuid);
if (publishToRemote) {
String path = getLayoutSetPrototype(portletDataContext, layoutSetPrototypeUuid);
File layoutSetPrototypeFile = null;
InputStream inputStream = null;
try {
layoutSetPrototypeFile =
SitesUtil.exportLayoutSetPrototype(layoutSetPrototype, serviceContext);
inputStream = new FileInputStream(layoutSetPrototypeFile);
portletDataContext.addZipEntry(path.concat(".lar"), inputStream);
portletDataContext.addZipEntry(path.concat(".xml"), layoutSetPrototype);
} finally {
StreamUtil.cleanUp(inputStream);
FileUtil.delete(layoutSetPrototypeFile);
}
}
}
for (Layout layout : layouts) {
exportLayout(
portletDataContext,
layoutConfigurationPortlet,
layoutCache,
portlets,
portletIds,
exportPermissions,
exportUserPermissions,
layout,
layoutsElement);
}
if (PropsValues.PERMISSIONS_USER_CHECK_ALGORITHM < 5) {
Element rolesElement = rootElement.addElement("roles");
if (exportPermissions) {
_permissionExporter.exportLayoutRoles(layoutCache, companyId, groupId, rolesElement);
}
}
long previousScopeGroupId = portletDataContext.getScopeGroupId();
Element portletsElement = rootElement.addElement("portlets");
for (Map.Entry<String, Object[]> portletIdsEntry : portletIds.entrySet()) {
Object[] portletObjects = portletIdsEntry.getValue();
String portletId = null;
long plid = 0;
long scopeGroupId = 0;
String scopeType = StringPool.BLANK;
String scopeLayoutUuid = null;
if (portletObjects.length == 4) {
portletId = (String) portletIdsEntry.getValue()[0];
plid = (Long) portletIdsEntry.getValue()[1];
scopeGroupId = (Long) portletIdsEntry.getValue()[2];
scopeLayoutUuid = (String) portletIdsEntry.getValue()[3];
} else {
portletId = (String) portletIdsEntry.getValue()[0];
plid = (Long) portletIdsEntry.getValue()[1];
scopeGroupId = (Long) portletIdsEntry.getValue()[2];
scopeType = (String) portletIdsEntry.getValue()[3];
scopeLayoutUuid = (String) portletIdsEntry.getValue()[4];
}
Layout layout = LayoutLocalServiceUtil.getLayout(plid);
portletDataContext.setPlid(layout.getPlid());
portletDataContext.setOldPlid(layout.getPlid());
portletDataContext.setScopeGroupId(scopeGroupId);
portletDataContext.setScopeType(scopeType);
portletDataContext.setScopeLayoutUuid(scopeLayoutUuid);
boolean[] exportPortletControls =
getExportPortletControls(companyId, portletId, portletDataContext, parameterMap);
_portletExporter.exportPortlet(
portletDataContext,
layoutCache,
portletId,
layout,
portletsElement,
defaultUserId,
exportPermissions,
exportPortletArchivedSetups,
exportPortletControls[0],
exportPortletControls[1],
exportPortletUserPreferences,
exportUserPermissions);
}
portletDataContext.setScopeGroupId(previousScopeGroupId);
if (exportCategories) {
exportAssetCategories(portletDataContext);
}
_portletExporter.exportAssetLinks(portletDataContext);
_portletExporter.exportAssetTags(portletDataContext);
_portletExporter.exportComments(portletDataContext);
_portletExporter.exportExpandoTables(portletDataContext);
_portletExporter.exportLocks(portletDataContext);
if (exportPermissions) {
_permissionExporter.exportPortletDataPermissions(portletDataContext);
}
_portletExporter.exportRatingsEntries(portletDataContext, rootElement);
if (exportTheme && !portletDataContext.isPerformDirectBinaryImport()) {
exportTheme(layoutSet, zipWriter);
}
if (_log.isInfoEnabled()) {
if (stopWatch != null) {
_log.info("Exporting layouts takes " + stopWatch.getTime() + " ms");
} else {
_log.info("Exporting layouts is finished");
}
}
portletDataContext.addZipEntry("/manifest.xml", document.formattedString());
try {
return zipWriter.getFile();
} finally {
if (updateLastPublishDate) {
updateLastPublishDate(layoutSet, lastPublishDate);
}
}
}
protected File doExport(PortletDataContext portletDataContext, long[] layoutIds)
throws Exception {
Map<String, String[]> parameterMap = portletDataContext.getParameterMap();
boolean ignoreLastPublishDate =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.IGNORE_LAST_PUBLISH_DATE);
boolean layoutSetPrototypeSettings =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.LAYOUT_SET_PROTOTYPE_SETTINGS);
boolean layoutSetSettings =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.LAYOUT_SET_SETTINGS);
boolean logo = MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.LOGO);
boolean permissions = MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.PERMISSIONS);
if (_log.isDebugEnabled()) {
_log.debug("Export permissions " + permissions);
}
LayoutSet layoutSet =
_layoutSetLocalService.getLayoutSet(
portletDataContext.getGroupId(), portletDataContext.isPrivateLayout());
long companyId = layoutSet.getCompanyId();
long defaultUserId = _userLocalService.getDefaultUserId(companyId);
ServiceContext serviceContext = ServiceContextThreadLocal.popServiceContext();
if (serviceContext == null) {
serviceContext = new ServiceContext();
}
serviceContext.setCompanyId(companyId);
serviceContext.setSignedIn(false);
serviceContext.setUserId(defaultUserId);
serviceContext.setAttribute("exporting", Boolean.TRUE);
long layoutSetBranchId = MapUtil.getLong(parameterMap, "layoutSetBranchId");
serviceContext.setAttribute("layoutSetBranchId", layoutSetBranchId);
ServiceContextThreadLocal.pushServiceContext(serviceContext);
if (ignoreLastPublishDate) {
portletDataContext.setEndDate(null);
portletDataContext.setStartDate(null);
}
StopWatch stopWatch = new StopWatch();
stopWatch.start();
Document document = SAXReaderUtil.createDocument();
Element rootElement = document.addElement("root");
portletDataContext.setExportDataRootElement(rootElement);
Element headerElement = rootElement.addElement("header");
headerElement.addAttribute(
"available-locales",
StringUtil.merge(LanguageUtil.getAvailableLocales(portletDataContext.getScopeGroupId())));
headerElement.addAttribute("build-number", String.valueOf(ReleaseInfo.getBuildNumber()));
headerElement.addAttribute("export-date", Time.getRFC822());
if (portletDataContext.hasDateRange()) {
headerElement.addAttribute("start-date", String.valueOf(portletDataContext.getStartDate()));
headerElement.addAttribute("end-date", String.valueOf(portletDataContext.getEndDate()));
}
headerElement.addAttribute("company-id", String.valueOf(portletDataContext.getCompanyId()));
headerElement.addAttribute(
"company-group-id", String.valueOf(portletDataContext.getCompanyGroupId()));
headerElement.addAttribute("group-id", String.valueOf(portletDataContext.getGroupId()));
headerElement.addAttribute(
"user-personal-site-group-id",
String.valueOf(portletDataContext.getUserPersonalSiteGroupId()));
headerElement.addAttribute(
"private-layout", String.valueOf(portletDataContext.isPrivateLayout()));
Group group = layoutSet.getGroup();
String type = "layout-set";
if (group.isLayoutPrototype()) {
type = "layout-prototype";
LayoutPrototype layoutPrototype =
_layoutPrototypeLocalService.getLayoutPrototype(group.getClassPK());
headerElement.addAttribute("type-uuid", layoutPrototype.getUuid());
layoutIds =
ExportImportHelperUtil.getAllLayoutIds(
portletDataContext.getGroupId(), portletDataContext.isPrivateLayout());
} else if (group.isLayoutSetPrototype()) {
type = "layout-set-prototype";
LayoutSetPrototype layoutSetPrototype =
_layoutSetPrototypeLocalService.getLayoutSetPrototype(group.getClassPK());
headerElement.addAttribute("type-uuid", layoutSetPrototype.getUuid());
}
headerElement.addAttribute("type", type);
LayoutSetBranch layoutSetBranch =
_layoutSetBranchLocalService.fetchLayoutSetBranch(layoutSetBranchId);
if (logo) {
Image image = null;
if (layoutSetBranch != null) {
image = _imageLocalService.getImage(layoutSetBranch.getLogoId());
} else {
image = _imageLocalService.getImage(layoutSet.getLogoId());
}
if ((image != null) && (image.getTextObj() != null)) {
String logoPath = ExportImportPathUtil.getRootPath(portletDataContext);
logoPath += "/logo";
headerElement.addAttribute("logo-path", logoPath);
portletDataContext.addZipEntry(logoPath, image.getTextObj());
}
}
String layoutSetPrototypeUuid = layoutSet.getLayoutSetPrototypeUuid();
if (layoutSetPrototypeSettings && Validator.isNotNull(layoutSetPrototypeUuid)) {
LayoutSetPrototype layoutSetPrototype =
_layoutSetPrototypeLocalService.getLayoutSetPrototypeByUuidAndCompanyId(
layoutSetPrototypeUuid, companyId);
headerElement.addAttribute("layout-set-prototype-uuid", layoutSetPrototypeUuid);
headerElement.addAttribute(
"layout-set-prototype-name", layoutSetPrototype.getName(LocaleUtil.getDefault()));
}
Element missingReferencesElement = rootElement.addElement("missing-references");
portletDataContext.setMissingReferencesElement(missingReferencesElement);
if (layoutSetBranch != null) {
_themeExporter.exportTheme(portletDataContext, layoutSetBranch);
} else {
_themeExporter.exportTheme(portletDataContext, layoutSet);
}
if (layoutSetSettings) {
Element settingsElement = headerElement.addElement("settings");
if (layoutSetBranch != null) {
settingsElement.addCDATA(layoutSetBranch.getSettings());
} else {
settingsElement.addCDATA(layoutSet.getSettings());
}
}
Map<String, Object[]> portletIds = new LinkedHashMap<>();
List<Layout> layouts =
_layoutLocalService.getLayouts(
portletDataContext.getGroupId(), portletDataContext.isPrivateLayout());
if (group.isStagingGroup()) {
group = group.getLiveGroup();
}
// Collect data portlets
for (Portlet portlet : ExportImportHelperUtil.getDataSiteLevelPortlets(companyId)) {
String portletId = portlet.getRootPortletId();
if (ExportImportThreadLocal.isStagingInProcess() && !group.isStagedPortlet(portletId)) {
continue;
}
// Calculate the amount of exported data
if (BackgroundTaskThreadLocal.hasBackgroundTask()) {
PortletDataHandler portletDataHandler = portlet.getPortletDataHandlerInstance();
portletDataHandler.prepareManifestSummary(portletDataContext);
}
// Add portlet ID to exportable portlets list
portletIds.put(
PortletPermissionUtil.getPrimaryKey(0, portletId),
new Object[] {
portletId,
LayoutConstants.DEFAULT_PLID,
portletDataContext.getGroupId(),
StringPool.BLANK,
StringPool.BLANK
});
if (!portlet.isScopeable()) {
continue;
}
// Scoped data
for (Layout layout : layouts) {
if (!ArrayUtil.contains(layoutIds, layout.getLayoutId())
|| !layout.isTypePortlet()
|| !layout.hasScopeGroup()) {
continue;
}
Group scopeGroup = layout.getScopeGroup();
portletIds.put(
PortletPermissionUtil.getPrimaryKey(layout.getPlid(), portlet.getPortletId()),
new Object[] {
portlet.getPortletId(),
layout.getPlid(),
scopeGroup.getGroupId(),
StringPool.BLANK,
layout.getUuid()
});
}
}
// Collect layout portlets
for (Layout layout : layouts) {
getLayoutPortlets(portletDataContext, layoutIds, portletIds, layout);
}
if (BackgroundTaskThreadLocal.hasBackgroundTask()) {
ManifestSummary manifestSummary = portletDataContext.getManifestSummary();
PortletDataHandlerStatusMessageSenderUtil.sendStatusMessage(
"layout", ArrayUtil.toStringArray(portletIds.keySet()), manifestSummary);
manifestSummary.resetCounters();
}
// Export actual data
portletDataContext.addDeletionSystemEventStagedModelTypes(new StagedModelType(Layout.class));
// Force to always have a layout group element
portletDataContext.getExportDataGroupElement(Layout.class);
for (Layout layout : layouts) {
exportLayout(portletDataContext, layoutIds, layout);
}
Element portletsElement = rootElement.addElement("portlets");
Element servicesElement = rootElement.addElement("services");
long previousScopeGroupId = portletDataContext.getScopeGroupId();
for (Map.Entry<String, Object[]> portletIdsEntry : portletIds.entrySet()) {
Object[] portletObjects = portletIdsEntry.getValue();
String portletId = null;
long plid = LayoutConstants.DEFAULT_PLID;
long scopeGroupId = 0;
String scopeType = StringPool.BLANK;
String scopeLayoutUuid = null;
if (portletObjects.length == 4) {
portletId = (String) portletIdsEntry.getValue()[0];
plid = (Long) portletIdsEntry.getValue()[1];
scopeGroupId = (Long) portletIdsEntry.getValue()[2];
scopeLayoutUuid = (String) portletIdsEntry.getValue()[3];
} else {
portletId = (String) portletIdsEntry.getValue()[0];
plid = (Long) portletIdsEntry.getValue()[1];
scopeGroupId = (Long) portletIdsEntry.getValue()[2];
scopeType = (String) portletIdsEntry.getValue()[3];
scopeLayoutUuid = (String) portletIdsEntry.getValue()[4];
}
Layout layout = _layoutLocalService.fetchLayout(plid);
if (layout == null) {
layout = new LayoutImpl();
layout.setCompanyId(companyId);
layout.setGroupId(portletDataContext.getGroupId());
}
portletDataContext.setPlid(plid);
portletDataContext.setOldPlid(plid);
portletDataContext.setPortletId(portletId);
portletDataContext.setScopeGroupId(scopeGroupId);
portletDataContext.setScopeType(scopeType);
portletDataContext.setScopeLayoutUuid(scopeLayoutUuid);
Map<String, Boolean> exportPortletControlsMap =
ExportImportHelperUtil.getExportPortletControlsMap(
companyId, portletId, parameterMap, type);
try {
_exportImportLifecycleManager.fireExportImportLifecycleEvent(
EVENT_PORTLET_EXPORT_STARTED,
getProcessFlag(),
PortletDataContextFactoryUtil.clonePortletDataContext(portletDataContext));
_portletExportController.exportPortlet(
portletDataContext,
layout,
portletsElement,
permissions,
exportPortletControlsMap.get(PortletDataHandlerKeys.PORTLET_ARCHIVED_SETUPS),
exportPortletControlsMap.get(PortletDataHandlerKeys.PORTLET_DATA),
exportPortletControlsMap.get(PortletDataHandlerKeys.PORTLET_SETUP),
exportPortletControlsMap.get(PortletDataHandlerKeys.PORTLET_USER_PREFERENCES));
_portletExportController.exportService(
portletDataContext,
servicesElement,
exportPortletControlsMap.get(PortletDataHandlerKeys.PORTLET_SETUP));
_exportImportLifecycleManager.fireExportImportLifecycleEvent(
EVENT_PORTLET_EXPORT_SUCCEEDED,
getProcessFlag(),
PortletDataContextFactoryUtil.clonePortletDataContext(portletDataContext));
} catch (Throwable t) {
_exportImportLifecycleManager.fireExportImportLifecycleEvent(
EVENT_PORTLET_EXPORT_FAILED,
getProcessFlag(),
PortletDataContextFactoryUtil.clonePortletDataContext(portletDataContext),
t);
throw t;
}
}
portletDataContext.setScopeGroupId(previousScopeGroupId);
_portletExportController.exportAssetLinks(portletDataContext);
_portletExportController.exportExpandoTables(portletDataContext);
_portletExportController.exportLocks(portletDataContext);
_deletionSystemEventExporter.exportDeletionSystemEvents(portletDataContext);
if (permissions) {
_permissionExporter.exportPortletDataPermissions(portletDataContext);
}
ExportImportHelperUtil.writeManifestSummary(document, portletDataContext.getManifestSummary());
if (_log.isInfoEnabled()) {
_log.info("Exporting layouts takes " + stopWatch.getTime() + " ms");
}
boolean updateLastPublishDate =
MapUtil.getBoolean(
portletDataContext.getParameterMap(), PortletDataHandlerKeys.UPDATE_LAST_PUBLISH_DATE);
if (ExportImportThreadLocal.isStagingInProcess() && updateLastPublishDate) {
ExportImportProcessCallbackRegistryUtil.registerCallback(
new UpdateLayoutSetLastPublishDateCallable(
portletDataContext.getDateRange(),
portletDataContext.getGroupId(),
portletDataContext.isPrivateLayout()));
}
portletDataContext.addZipEntry("/manifest.xml", document.formattedString());
ZipWriter zipWriter = portletDataContext.getZipWriter();
return zipWriter.getFile();
}
protected File doExportLayoutsAsFile(
long groupId,
boolean privateLayout,
long[] layoutIds,
Map<String, String[]> parameterMap,
Date startDate,
Date endDate)
throws Exception {
boolean exportCategories = MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.CATEGORIES);
boolean exportIgnoreLastPublishDate =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.IGNORE_LAST_PUBLISH_DATE);
boolean exportPermissions =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.PERMISSIONS);
boolean exportPortletDataAll =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.PORTLET_DATA_ALL);
boolean exportTheme = MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.THEME);
boolean exportThemeSettings =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.THEME_REFERENCE);
boolean exportLogo = MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.LOGO);
boolean exportLayoutSetSettings =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.LAYOUT_SET_SETTINGS);
boolean updateLastPublishDate =
MapUtil.getBoolean(parameterMap, PortletDataHandlerKeys.UPDATE_LAST_PUBLISH_DATE);
if (_log.isDebugEnabled()) {
_log.debug("Export permissions " + exportPermissions);
_log.debug("Export theme " + exportTheme);
}
LayoutSet layoutSet = LayoutSetLocalServiceUtil.getLayoutSet(groupId, privateLayout);
long companyId = layoutSet.getCompanyId();
long defaultUserId = UserLocalServiceUtil.getDefaultUserId(companyId);
ServiceContext serviceContext = ServiceContextThreadLocal.getServiceContext();
if (serviceContext == null) {
serviceContext = new ServiceContext();
serviceContext.setCompanyId(companyId);
serviceContext.setSignedIn(false);
serviceContext.setUserId(defaultUserId);
ServiceContextThreadLocal.pushServiceContext(serviceContext);
}
serviceContext.setAttribute("exporting", Boolean.TRUE);
long layoutSetBranchId = MapUtil.getLong(parameterMap, "layoutSetBranchId");
serviceContext.setAttribute("layoutSetBranchId", layoutSetBranchId);
long lastPublishDate = System.currentTimeMillis();
if (endDate != null) {
lastPublishDate = endDate.getTime();
}
if (exportIgnoreLastPublishDate) {
endDate = null;
startDate = null;
}
StopWatch stopWatch = null;
if (_log.isInfoEnabled()) {
stopWatch = new StopWatch();
stopWatch.start();
}
LayoutCache layoutCache = new LayoutCache();
ZipWriter zipWriter = ZipWriterFactoryUtil.getZipWriter();
PortletDataContext portletDataContext =
PortletDataContextFactoryUtil.createExportPortletDataContext(
companyId, groupId, parameterMap, startDate, endDate, zipWriter);
portletDataContext.setPortetDataContextListener(
new PortletDataContextListenerImpl(portletDataContext));
Document document = SAXReaderUtil.createDocument();
Element rootElement = document.addElement("root");
portletDataContext.setExportDataRootElement(rootElement);
Element headerElement = rootElement.addElement("header");
headerElement.addAttribute(
"available-locales",
StringUtil.merge(LanguageUtil.getAvailableLocales(portletDataContext.getScopeGroupId())));
headerElement.addAttribute("build-number", String.valueOf(ReleaseInfo.getBuildNumber()));
headerElement.addAttribute("export-date", Time.getRFC822());
if (portletDataContext.hasDateRange()) {
headerElement.addAttribute("start-date", String.valueOf(portletDataContext.getStartDate()));
headerElement.addAttribute("end-date", String.valueOf(portletDataContext.getEndDate()));
}
headerElement.addAttribute("company-id", String.valueOf(portletDataContext.getCompanyId()));
headerElement.addAttribute(
"company-group-id", String.valueOf(portletDataContext.getCompanyGroupId()));
headerElement.addAttribute("group-id", String.valueOf(groupId));
headerElement.addAttribute(
"user-personal-site-group-id",
String.valueOf(portletDataContext.getUserPersonalSiteGroupId()));
headerElement.addAttribute("private-layout", String.valueOf(privateLayout));
Group group = layoutSet.getGroup();
String type = "layout-set";
if (group.isLayoutPrototype()) {
type = "layout-prototype";
LayoutPrototype layoutPrototype =
LayoutPrototypeLocalServiceUtil.getLayoutPrototype(group.getClassPK());
headerElement.addAttribute("type-uuid", layoutPrototype.getUuid());
} else if (group.isLayoutSetPrototype()) {
type = "layout-set-prototype";
LayoutSetPrototype layoutSetPrototype =
LayoutSetPrototypeLocalServiceUtil.getLayoutSetPrototype(group.getClassPK());
headerElement.addAttribute("type-uuid", layoutSetPrototype.getUuid());
}
headerElement.addAttribute("type", type);
if (exportTheme || exportThemeSettings) {
headerElement.addAttribute("theme-id", layoutSet.getThemeId());
headerElement.addAttribute("color-scheme-id", layoutSet.getColorSchemeId());
}
if (exportLogo) {
Image image = ImageLocalServiceUtil.getImage(layoutSet.getLogoId());
if ((image != null) && (image.getTextObj() != null)) {
String logoPath = ExportImportPathUtil.getRootPath(portletDataContext);
logoPath += "/logo";
headerElement.addAttribute("logo-path", logoPath);
portletDataContext.addZipEntry(logoPath, image.getTextObj());
}
}
if (exportLayoutSetSettings) {
Element settingsElement = headerElement.addElement("settings");
settingsElement.addCDATA(layoutSet.getSettings());
}
Element cssElement = headerElement.addElement("css");
cssElement.addCDATA(layoutSet.getCss());
Map<String, Object[]> portletIds = new LinkedHashMap<String, Object[]>();
List<Layout> layouts = LayoutLocalServiceUtil.getLayouts(groupId, privateLayout);
List<Portlet> portlets = getDataSiteLevelPortlets(companyId);
long plid = LayoutConstants.DEFAULT_PLID;
if (!layouts.isEmpty()) {
Layout firstLayout = layouts.get(0);
plid = firstLayout.getPlid();
}
if (group.isStagingGroup()) {
group = group.getLiveGroup();
}
for (Portlet portlet : portlets) {
String portletId = portlet.getRootPortletId();
if (!group.isStagedPortlet(portletId)) {
continue;
}
String key = PortletPermissionUtil.getPrimaryKey(0, portletId);
if (portletIds.get(key) == null) {
portletIds.put(
key, new Object[] {portletId, plid, groupId, StringPool.BLANK, StringPool.BLANK});
}
}
Element missingReferencesElement = rootElement.addElement("missing-references");
portletDataContext.setMissingReferencesElement(missingReferencesElement);
portletDataContext.addDeletionSystemEventStagedModelTypes(new StagedModelType(Layout.class));
Element layoutsElement = portletDataContext.getExportDataGroupElement(Layout.class);
String layoutSetPrototypeUuid = layoutSet.getLayoutSetPrototypeUuid();
if (Validator.isNotNull(layoutSetPrototypeUuid)) {
LayoutSetPrototype layoutSetPrototype =
LayoutSetPrototypeLocalServiceUtil.getLayoutSetPrototypeByUuidAndCompanyId(
layoutSetPrototypeUuid, companyId);
layoutsElement.addAttribute("layout-set-prototype-uuid", layoutSetPrototypeUuid);
layoutsElement.addAttribute(
"layout-set-prototype-name", layoutSetPrototype.getName(LocaleUtil.getDefault()));
}
for (Layout layout : layouts) {
exportLayout(portletDataContext, portlets, layoutIds, portletIds, layout);
}
long previousScopeGroupId = portletDataContext.getScopeGroupId();
Element portletsElement = rootElement.addElement("portlets");
for (Map.Entry<String, Object[]> portletIdsEntry : portletIds.entrySet()) {
Object[] portletObjects = portletIdsEntry.getValue();
String portletId = null;
plid = LayoutConstants.DEFAULT_PLID;
long scopeGroupId = 0;
String scopeType = StringPool.BLANK;
String scopeLayoutUuid = null;
if (portletObjects.length == 4) {
portletId = (String) portletIdsEntry.getValue()[0];
plid = (Long) portletIdsEntry.getValue()[1];
scopeGroupId = (Long) portletIdsEntry.getValue()[2];
scopeLayoutUuid = (String) portletIdsEntry.getValue()[3];
} else {
portletId = (String) portletIdsEntry.getValue()[0];
plid = (Long) portletIdsEntry.getValue()[1];
scopeGroupId = (Long) portletIdsEntry.getValue()[2];
scopeType = (String) portletIdsEntry.getValue()[3];
scopeLayoutUuid = (String) portletIdsEntry.getValue()[4];
}
Layout layout = LayoutLocalServiceUtil.fetchLayout(plid);
if (layout == null) {
if (!group.isCompany() && (plid <= LayoutConstants.DEFAULT_PLID)) {
continue;
}
if (_log.isWarnEnabled()) {
_log.warn("Assuming global scope because no layout was found");
}
layout = new LayoutImpl();
layout.setGroupId(groupId);
layout.setCompanyId(companyId);
}
portletDataContext.setPlid(plid);
portletDataContext.setOldPlid(plid);
portletDataContext.setScopeGroupId(scopeGroupId);
portletDataContext.setScopeType(scopeType);
portletDataContext.setScopeLayoutUuid(scopeLayoutUuid);
boolean[] exportPortletControls =
getExportPortletControls(companyId, portletId, parameterMap, type);
_portletExporter.exportPortlet(
portletDataContext,
layoutCache,
portletId,
layout,
portletsElement,
defaultUserId,
exportPermissions,
exportPortletControls[0],
exportPortletControls[1],
exportPortletControls[2],
exportPortletControls[3]);
}
portletDataContext.setScopeGroupId(previousScopeGroupId);
exportAssetCategories(
portletDataContext, exportPortletDataAll, exportCategories, group.isCompany());
_portletExporter.exportAssetLinks(portletDataContext);
_portletExporter.exportAssetTags(portletDataContext);
_portletExporter.exportComments(portletDataContext);
_portletExporter.exportExpandoTables(portletDataContext);
_portletExporter.exportLocks(portletDataContext);
_deletionSystemEventExporter.exportDeletionSystemEvents(portletDataContext);
if (exportPermissions) {
_permissionExporter.exportPortletDataPermissions(portletDataContext);
}
_portletExporter.exportRatingsEntries(portletDataContext, rootElement);
if (exportTheme && !portletDataContext.isPerformDirectBinaryImport()) {
exportTheme(layoutSet, zipWriter);
}
ExportImportHelperUtil.writeManifestSummary(document, portletDataContext.getManifestSummary());
if (_log.isInfoEnabled()) {
if (stopWatch != null) {
_log.info("Exporting layouts takes " + stopWatch.getTime() + " ms");
} else {
_log.info("Exporting layouts is finished");
}
}
portletDataContext.addZipEntry("/manifest.xml", document.formattedString());
try {
return zipWriter.getFile();
} finally {
if (updateLastPublishDate) {
updateLastPublishDate(layoutSet, lastPublishDate);
}
}
}
