protected void copyResourcePermissions(String sourcePortletId, String targetPortletId) {
Layout layout = getLayout();
Portlet portlet = PortletLocalServiceUtil.getPortletById(getCompanyId(), sourcePortletId);
String sourcePortletPrimaryKey =
PortletPermissionUtil.getPrimaryKey(layout.getPlid(), sourcePortletId);
List<ResourcePermission> resourcePermissions =
ResourcePermissionLocalServiceUtil.getResourcePermissions(
portlet.getCompanyId(),
portlet.getPortletName(),
PortletKeys.PREFS_OWNER_TYPE_USER,
sourcePortletPrimaryKey);
for (ResourcePermission resourcePermission : resourcePermissions) {
String targetPortletPrimaryKey =
PortletPermissionUtil.getPrimaryKey(layout.getPlid(), targetPortletId);
resourcePermission.setResourcePermissionId(CounterLocalServiceUtil.increment());
resourcePermission.setPrimKey(targetPortletPrimaryKey);
ResourcePermissionLocalServiceUtil.addResourcePermission(resourcePermission);
}
}
public boolean isShowConfigurationIcon() throws PortalException {
if (_showConfigurationIcon != null) {
return _showConfigurationIcon;
}
_showConfigurationIcon =
PortletPermissionUtil.contains(
getPermissionChecker(), getLayout(), getPortletId(), ActionKeys.CONFIGURATION);
return _showConfigurationIcon;
}
public void setLayoutAssetEntry(AssetEntry assetEntry) throws PortalException {
ThemeDisplay themeDisplay = (ThemeDisplay) _request.getAttribute(WebKeys.THEME_DISPLAY);
String defaultAssetPublisherPortletId =
AssetUtil.getDefaultAssetPublisherId(themeDisplay.getLayout());
if (isDefaultAssetPublisher()
|| Validator.isNull(defaultAssetPublisherPortletId)
|| !PortletPermissionUtil.contains(
themeDisplay.getPermissionChecker(),
themeDisplay.getLayout(),
defaultAssetPublisherPortletId,
ActionKeys.VIEW)) {
_request.setAttribute(WebKeys.LAYOUT_ASSET_ENTRY, assetEntry);
}
}
public boolean isShowConfigurationIcon() throws PortalException {
if (_showConfigurationIcon != null) {
return _showConfigurationIcon;
}
if (isPreview() || (isSharedURL() && isFormShared())) {
_showConfigurationIcon = false;
return _showConfigurationIcon;
}
ThemeDisplay themeDisplay = getThemeDisplay();
_showConfigurationIcon =
PortletPermissionUtil.contains(
themeDisplay.getPermissionChecker(),
themeDisplay.getLayout(),
getPortletId(),
ActionKeys.CONFIGURATION);
return _showConfigurationIcon;
}
protected String getUserPreference(String key) {
String value = StringPool.BLANK;
if (!hasUserPreferences()) {
return value;
}
value =
_portalPreferences.getValue(CustomizedPages.namespacePlid(getPlid()), key, StringPool.NULL);
if (!value.equals(StringPool.NULL)) {
return value;
}
value = getTypeSettingsProperty(key);
if (Validator.isNull(value)) {
return value;
}
List<String> newPortletIds = new ArrayList<>();
PermissionChecker permissionChecker = PermissionThreadLocal.getPermissionChecker();
String[] portletIds = StringUtil.split(value);
for (String portletId : portletIds) {
try {
if (!PortletPermissionUtil.contains(
permissionChecker, getLayout(), portletId, ActionKeys.VIEW, true)) {
continue;
}
String rootPortletId = PortletConstants.getRootPortletId(portletId);
if (!PortletPermissionUtil.contains(
permissionChecker, rootPortletId, ActionKeys.ADD_TO_PAGE)) {
continue;
}
} catch (Exception e) {
_log.error(e, e);
}
String newPortletId = null;
boolean preferencesUniquePerLayout = false;
try {
Portlet portlet = PortletLocalServiceUtil.getPortletById(getCompanyId(), portletId);
preferencesUniquePerLayout = portlet.isPreferencesUniquePerLayout();
} catch (SystemException se) {
_log.error(se, se);
}
if (PortletConstants.hasInstanceId(portletId) || preferencesUniquePerLayout) {
String instanceId = null;
if (PortletConstants.hasInstanceId(portletId)) {
instanceId = PortletConstants.generateInstanceId();
}
newPortletId =
PortletConstants.assemblePortletId(
portletId, _portalPreferences.getUserId(), instanceId);
copyPreferences(_portalPreferences.getUserId(), portletId, newPortletId);
copyResourcePermissions(portletId, newPortletId);
} else {
newPortletId = portletId;
}
newPortletIds.add(newPortletId);
}
value = StringUtil.merge(newPortletIds);
setUserPreference(key, value);
return value;
}
protected String addPortletId(
long userId,
String portletId,
String columnId,
int columnPos,
boolean checkPermission,
boolean strictHasPortlet) {
portletId = JS.getSafeName(portletId);
Layout layout = getLayout();
Portlet portlet = null;
try {
portlet = PortletLocalServiceUtil.getPortletById(layout.getCompanyId(), portletId);
if (portlet == null) {
if (_log.isWarnEnabled()) {
_log.warn("Portlet " + portletId + " cannot be added because it is not registered");
}
return null;
}
PermissionChecker permissionChecker = PermissionThreadLocal.getPermissionChecker();
if (checkPermission
&& !PortletPermissionUtil.contains(
permissionChecker, layout, portlet, ActionKeys.ADD_TO_PAGE)) {
return null;
}
} catch (Exception e) {
_log.error(e, e);
}
if (portlet.isSystem()) {
return null;
}
if (portlet.isInstanceable() && !PortletConstants.hasInstanceId(portletId)) {
portletId =
PortletConstants.assemblePortletId(portletId, PortletConstants.generateInstanceId());
}
if (hasPortletId(portletId, strictHasPortlet)) {
return null;
}
if (columnId == null) {
LayoutTemplate layoutTemplate = getLayoutTemplate();
List<String> columns = layoutTemplate.getColumns();
if (!columns.isEmpty()) {
columnId = columns.get(0);
}
}
if (columnId == null) {
return null;
}
if (isCustomizable()) {
if (isColumnDisabled(columnId)) {
return null;
}
if ((PortletConstants.hasInstanceId(portletId) || portlet.isPreferencesUniquePerLayout())
&& hasUserPreferences()) {
portletId = PortletConstants.assemblePortletId(portletId, userId);
}
}
String columnValue = StringPool.BLANK;
if (hasUserPreferences()) {
columnValue = getUserPreference(columnId);
} else {
columnValue = getTypeSettingsProperty(columnId);
}
if ((columnValue == null) && columnId.startsWith(_NESTED_PORTLETS_NAMESPACE)) {
addNestedColumn(columnId);
}
if (columnPos >= 0) {
List<String> portletIds = ListUtil.fromArray(StringUtil.split(columnValue));
if (columnPos <= portletIds.size()) {
portletIds.add(columnPos, portletId);
} else {
portletIds.add(portletId);
}
columnValue = StringUtil.merge(portletIds);
} else {
columnValue = StringUtil.add(columnValue, portletId);
}
if (hasUserPreferences()) {
setUserPreference(columnId, columnValue);
} else {
setTypeSettingsProperty(columnId, columnValue);
}
try {
if (_enablePortletLayoutListener && !portlet.isUndeployedPortlet()) {
PortletLayoutListener portletLayoutListener = portlet.getPortletLayoutListenerInstance();
if (portletLayoutListener != null) {
portletLayoutListener.onAddToLayout(portletId, layout.getPlid());
}
}
} catch (Exception e) {
_log.error("Unable to fire portlet layout listener event", e);
}
return portletId;
}
protected void getLayoutPortlets(
PortletDataContext portletDataContext,
long[] layoutIds,
Map<String, Object[]> portletIds,
Layout layout)
throws Exception {
if (!ArrayUtil.contains(layoutIds, layout.getLayoutId())) {
return;
}
if (!prepareLayoutStagingHandler(portletDataContext, layout)
|| !layout.isSupportsEmbeddedPortlets()) {
// Only portlet type layouts support page scoping
return;
}
LayoutTypePortlet layoutTypePortlet = (LayoutTypePortlet) layout.getLayoutType();
// The getAllPortlets method returns all effective nonsystem portlets
// for any layout type, including embedded portlets, or in the case of
// panel type layout, selected portlets
for (Portlet portlet : layoutTypePortlet.getAllPortlets(false)) {
String portletId = portlet.getPortletId();
Settings portletInstanceSettings =
SettingsFactoryUtil.getSettings(new PortletInstanceSettingsLocator(layout, portletId));
String scopeType = portletInstanceSettings.getValue("lfrScopeType", null);
String scopeLayoutUuid = portletInstanceSettings.getValue("lfrScopeLayoutUuid", null);
long scopeGroupId = portletDataContext.getScopeGroupId();
if (Validator.isNotNull(scopeType)) {
Group scopeGroup = null;
if (scopeType.equals("company")) {
scopeGroup = _groupLocalService.getCompanyGroup(layout.getCompanyId());
} else if (scopeType.equals("layout")) {
Layout scopeLayout = null;
scopeLayout =
_layoutLocalService.fetchLayoutByUuidAndGroupId(
scopeLayoutUuid,
portletDataContext.getGroupId(),
portletDataContext.isPrivateLayout());
if (scopeLayout == null) {
continue;
}
scopeGroup = scopeLayout.getScopeGroup();
} else {
throw new IllegalArgumentException("Scope type " + scopeType + " is invalid");
}
if (scopeGroup != null) {
scopeGroupId = scopeGroup.getGroupId();
}
}
String key = PortletPermissionUtil.getPrimaryKey(layout.getPlid(), portletId);
portletIds.put(
key,
new Object[] {portletId, layout.getPlid(), scopeGroupId, scopeType, scopeLayoutUuid});
}
}
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();
}
