public void restoreArchivedSetup(ActionRequest actionRequest, ActionResponse actionResponse)
throws Exception {
Portlet portlet = ActionUtil.getPortlet(actionRequest);
ThemeDisplay themeDisplay = (ThemeDisplay) actionRequest.getAttribute(WebKeys.THEME_DISPLAY);
Settings portletInstanceSettings =
SettingsFactoryUtil.getSettings(
new PortletInstanceSettingsLocator(themeDisplay.getLayout(), portlet.getPortletId()));
ModifiableSettings portletInstanceModifiableSettings =
portletInstanceSettings.getModifiableSettings();
String name = ParamUtil.getString(actionRequest, "name");
ArchivedSettings archivedSettings =
SettingsFactoryUtil.getPortletInstanceArchivedSettings(
themeDisplay.getSiteGroupId(), portlet.getRootPortletId(), name);
portletInstanceModifiableSettings.reset();
portletInstanceModifiableSettings.setValues(archivedSettings);
portletInstanceModifiableSettings.store();
String portletResource = ParamUtil.getString(actionRequest, "portletResource");
SessionMessages.add(
actionRequest,
PortalUtil.getPortletId(actionRequest) + SessionMessages.KEY_SUFFIX_REFRESH_PORTLET,
portletResource);
}
public void initPermissions(long companyId, List<Portlet> portlets) {
Role powerUserRole = getPowerUserRole(companyId);
if (powerUserRole == null) {
return;
}
Group userPersonalSiteGroup = getUserPersonalSiteGroup(companyId);
if (userPersonalSiteGroup == null) {
return;
}
for (Portlet portlet : portlets) {
try {
initPermissions(
companyId,
powerUserRole.getRoleId(),
portlet.getRootPortletId(),
userPersonalSiteGroup.getGroupId());
} catch (PortalException pe) {
_log.error(
"Unable to initialize user personal site permissions "
+ "for portlet "
+ portlet.getPortletId()
+ " in company "
+ companyId,
pe);
}
}
}
public void deleteArchivedSetups(ActionRequest actionRequest, ActionResponse actionResponse)
throws Exception {
Portlet portlet = ActionUtil.getPortlet(actionRequest);
ThemeDisplay themeDisplay = (ThemeDisplay) actionRequest.getAttribute(WebKeys.THEME_DISPLAY);
String[] names = null;
String name = ParamUtil.getString(actionRequest, "name");
if (Validator.isNotNull(name)) {
names = new String[] {name};
} else {
names = ParamUtil.getStringValues(actionRequest, "rowIds");
}
for (String curName : names) {
ArchivedSettings archivedSettings =
SettingsFactoryUtil.getPortletInstanceArchivedSettings(
themeDisplay.getSiteGroupId(), portlet.getRootPortletId(), curName);
archivedSettings.delete();
}
}
public void initPermissions(List<Company> companies, Portlet portlet) {
String rootPortletId = portlet.getRootPortletId();
for (Company company : companies) {
long companyId = company.getCompanyId();
Role powerUserRole = getPowerUserRole(companyId);
if (powerUserRole == null) {
continue;
}
Group userPersonalSiteGroup = getUserPersonalSiteGroup(companyId);
if (userPersonalSiteGroup == null) {
continue;
}
try {
initPermissions(
companyId,
powerUserRole.getRoleId(),
rootPortletId,
userPersonalSiteGroup.getGroupId());
} catch (PortalException pe) {
_log.error(
"Unable to initialize user personal site permissions "
+ "for portlet "
+ portlet.getPortletId()
+ " in company "
+ companyId,
pe);
}
}
}
@Override
public void clear(Portlet portlet, boolean resetRemotePortletBag) {
String rootPortletId = portlet.getRootPortletId();
Map<String, InvokerPortlet> portletInstances = _pool.remove(rootPortletId);
if (portletInstances != null) {
InvokerPortlet rootInvokerPortletInstance = portletInstances.remove(rootPortletId);
if (rootInvokerPortletInstance != null) {
rootInvokerPortletInstance.destroy();
}
portletInstances.clear();
}
PortletApp portletApp = portlet.getPortletApp();
if (resetRemotePortletBag && portletApp.isWARFile()) {
PortletBag portletBag = PortletBagPool.remove(rootPortletId);
if (portletBag != null) {
portletBag.destroy();
}
}
}
@Override
public void delete(Portlet portlet) {
if (PortletConstants.hasInstanceId(portlet.getPortletId())) {
Map<String, InvokerPortlet> portletInstances = _pool.get(portlet.getRootPortletId());
if (portletInstances != null) {
portletInstances.remove(portlet.getPortletId());
}
}
}
public void updateArchivedSetup(ActionRequest actionRequest, ActionResponse actionResponse)
throws Exception {
Portlet portlet = ActionUtil.getPortlet(actionRequest);
ThemeDisplay themeDisplay = (ThemeDisplay) actionRequest.getAttribute(WebKeys.THEME_DISPLAY);
String name = ParamUtil.getString(actionRequest, "name");
ArchivedSettings archivedSettings =
SettingsFactoryUtil.getPortletInstanceArchivedSettings(
themeDisplay.getSiteGroupId(), portlet.getRootPortletId(), name);
Settings portletInstanceSettings =
SettingsFactoryUtil.getSettings(
new PortletInstanceSettingsLocator(themeDisplay.getLayout(), portlet.getPortletId()));
ModifiableSettings portletInstanceModifiableSettings =
portletInstanceSettings.getModifiableSettings();
archivedSettings.setValues(portletInstanceModifiableSettings);
archivedSettings.store();
}
@Override
public InvokerPortlet create(
Portlet portlet, ServletContext servletContext, boolean destroyPrevious)
throws PortletException {
if (destroyPrevious) {
destroyRelated(portlet);
}
boolean instanceable = false;
boolean deployed = !portlet.isUndeployedPortlet();
if (portlet.isInstanceable()
&& deployed
&& PortletConstants.hasInstanceId(portlet.getPortletId())) {
instanceable = true;
}
String rootPortletId = portlet.getRootPortletId();
InvokerPortlet rootInvokerPortletInstance = null;
Map<String, InvokerPortlet> portletInstances = null;
if (deployed) {
portletInstances = _pool.get(rootPortletId);
if (portletInstances == null) {
portletInstances = new ConcurrentHashMap<>();
_pool.put(rootPortletId, portletInstances);
} else {
if (instanceable) {
InvokerPortlet instanceInvokerPortletInstance =
portletInstances.get(portlet.getPortletId());
if (instanceInvokerPortletInstance != null) {
return instanceInvokerPortletInstance;
}
}
rootInvokerPortletInstance = portletInstances.get(rootPortletId);
}
}
if (rootInvokerPortletInstance == null) {
PortletBag portletBag = PortletBagPool.get(rootPortletId);
// Portlet bag should never be null unless the portlet has been
// undeployed
if (portletBag == null) {
PortletBagFactory portletBagFactory = new PortletBagFactory();
portletBagFactory.setClassLoader(ClassLoaderUtil.getPortalClassLoader());
portletBagFactory.setServletContext(servletContext);
portletBagFactory.setWARFile(false);
try {
portletBag = portletBagFactory.create(portlet);
} catch (Exception e) {
throw new PortletException(e);
}
}
PortletConfig portletConfig = PortletConfigFactoryUtil.create(portlet, servletContext);
rootInvokerPortletInstance = init(portlet, portletConfig, portletBag.getPortletInstance());
if (deployed) {
portletInstances.put(rootPortletId, rootInvokerPortletInstance);
}
}
if (!instanceable) {
return rootInvokerPortletInstance;
}
javax.portlet.Portlet portletInstance = rootInvokerPortletInstance.getPortletInstance();
PortletConfig portletConfig = PortletConfigFactoryUtil.create(portlet, servletContext);
PortletContext portletContext = portletConfig.getPortletContext();
boolean checkAuthToken = rootInvokerPortletInstance.isCheckAuthToken();
boolean facesPortlet = rootInvokerPortletInstance.isFacesPortlet();
boolean strutsPortlet = rootInvokerPortletInstance.isStrutsPortlet();
boolean strutsBridgePortlet = rootInvokerPortletInstance.isStrutsBridgePortlet();
InvokerPortlet instanceInvokerPortletInstance =
_invokerPortletFactory.create(
portlet,
portletInstance,
portletConfig,
portletContext,
(InvokerFilterContainer) rootInvokerPortletInstance,
checkAuthToken,
facesPortlet,
strutsPortlet,
strutsBridgePortlet);
if (deployed) {
portletInstances.put(portlet.getPortletId(), instanceInvokerPortletInstance);
}
return instanceInvokerPortletInstance;
}
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();
}
