/**
* Adds the layout revision to the database. Also notifies the appropriate model listeners.
*
* @param layoutRevision the layout revision
* @return the layout revision that was added
* @throws SystemException if a system exception occurred
*/
@Indexable(type = IndexableType.REINDEX)
@Override
public LayoutRevision addLayoutRevision(LayoutRevision layoutRevision) throws SystemException {
layoutRevision.setNew(true);
return layoutRevisionPersistence.update(layoutRevision);
}
@Override
public AssetEntry getAssetEntry(String className, long classPK)
throws PortalException, SystemException {
LayoutRevision layoutRevision = LayoutRevisionLocalServiceUtil.getLayoutRevision(classPK);
LayoutSetBranch layoutSetBranch =
LayoutSetBranchLocalServiceUtil.getLayoutSetBranch(layoutRevision.getLayoutSetBranchId());
User user = UserLocalServiceUtil.getUserById(layoutRevision.getUserId());
AssetEntry assetEntry = AssetEntryLocalServiceUtil.createAssetEntry(classPK);
assetEntry.setGroupId(layoutRevision.getGroupId());
assetEntry.setCompanyId(user.getCompanyId());
assetEntry.setUserId(user.getUserId());
assetEntry.setUserName(user.getFullName());
assetEntry.setCreateDate(layoutRevision.getCreateDate());
assetEntry.setClassNameId(PortalUtil.getClassNameId(LayoutRevision.class.getName()));
assetEntry.setClassPK(layoutRevision.getLayoutRevisionId());
StringBundler sb = new StringBundler(4);
sb.append(layoutRevision.getHTMLTitle(LocaleUtil.getSiteDefault()));
sb.append(" [");
sb.append(layoutSetBranch.getName());
sb.append("]");
assetEntry.setTitle(sb.toString());
return assetEntry;
}
protected void populateElementLayoutMetadata(Element layoutElement, Layout layout)
throws Exception {
LayoutStagingHandler layoutStagingHandler = LayoutStagingUtil.getLayoutStagingHandler(layout);
if (layoutStagingHandler != null) {
LayoutRevision layoutRevision = layoutStagingHandler.getLayoutRevision();
if (layoutRevision != null) {
layoutElement.addAttribute(
"layout-revision-id", String.valueOf(layoutRevision.getLayoutRevisionId()));
layoutElement.addAttribute(
"layout-branch-id", String.valueOf(layoutRevision.getLayoutBranchId()));
LayoutBranch layoutBranch = layoutRevision.getLayoutBranch();
layoutElement.addAttribute("layout-branch-name", String.valueOf(layoutBranch.getName()));
}
}
layoutElement.addAttribute("layout-uuid", layout.getUuid());
layoutElement.addAttribute("layout-id", String.valueOf(layout.getLayoutId()));
layoutElement.addAttribute("layout-priority", String.valueOf(layout.getPriority()));
String layoutPrototypeUuid = layout.getLayoutPrototypeUuid();
if (Validator.isNotNull(layoutPrototypeUuid)) {
LayoutPrototype layoutPrototype =
_layoutPrototypeLocalService.getLayoutPrototypeByUuidAndCompanyId(
layoutPrototypeUuid, layout.getCompanyId());
layoutElement.addAttribute("layout-prototype-uuid", layoutPrototypeUuid);
layoutElement.addAttribute(
"layout-prototype-name", layoutPrototype.getName(LocaleUtil.getDefault()));
}
}
@Test
public void testCleanUpLayoutRevisionPortletPreferences() throws Exception {
LayoutRevision layoutRevision = getLayoutRevision();
PortletPreferences portletPreferences =
PortletPreferencesLocalServiceUtil.addPortletPreferences(
TestPropsValues.getCompanyId(),
TestPropsValues.getUserId(),
0,
layoutRevision.getLayoutRevisionId(),
RandomTestUtil.randomString(),
new PortletImpl(),
StringPool.BLANK);
Assert.assertNotNull(portletPreferences);
doVerify();
portletPreferences =
PortletPreferencesLocalServiceUtil.fetchPortletPreferences(
portletPreferences.getPortletPreferencesId());
Assert.assertNull(portletPreferences);
}
protected void exportLayout(
PortletDataContext portletDataContext,
Portlet layoutConfigurationPortlet,
LayoutCache layoutCache,
List<Portlet> portlets,
Map<String, Object[]> portletIds,
boolean exportPermissions,
boolean exportUserPermissions,
Layout layout,
Element layoutsElement)
throws Exception {
String path = portletDataContext.getLayoutPath(layout.getLayoutId()) + "/layout.xml";
if (!portletDataContext.isPathNotProcessed(path)) {
return;
}
LayoutRevision layoutRevision = null;
if (LayoutStagingUtil.isBranchingLayout(layout)) {
ServiceContext serviceContext = ServiceContextThreadLocal.getServiceContext();
long layoutSetBranchId = ParamUtil.getLong(serviceContext, "layoutSetBranchId");
if (layoutSetBranchId <= 0) {
return;
}
layoutRevision = LayoutRevisionUtil.fetchByL_H_P(layoutSetBranchId, true, layout.getPlid());
if (layoutRevision == null) {
return;
}
LayoutStagingHandler layoutStagingHandler = LayoutStagingUtil.getLayoutStagingHandler(layout);
layoutStagingHandler.setLayoutRevision(layoutRevision);
}
Element layoutElement = layoutsElement.addElement("layout");
if (layoutRevision != null) {
layoutElement.addAttribute(
"layout-revision-id", String.valueOf(layoutRevision.getLayoutRevisionId()));
layoutElement.addAttribute(
"layout-branch-id", String.valueOf(layoutRevision.getLayoutBranchId()));
layoutElement.addAttribute(
"layout-branch-name", String.valueOf(layoutRevision.getLayoutBranch().getName()));
}
layoutElement.addAttribute("layout-uuid", layout.getUuid());
layoutElement.addAttribute("layout-id", String.valueOf(layout.getLayoutId()));
long parentLayoutId = layout.getParentLayoutId();
if (parentLayoutId != LayoutConstants.DEFAULT_PARENT_LAYOUT_ID) {
Layout parentLayout =
LayoutLocalServiceUtil.getLayout(
layout.getGroupId(), layout.isPrivateLayout(), parentLayoutId);
if (parentLayout != null) {
layoutElement.addAttribute("parent-layout-uuid", parentLayout.getUuid());
}
}
boolean deleteLayout =
MapUtil.getBoolean(portletDataContext.getParameterMap(), "delete_" + layout.getPlid());
if (deleteLayout) {
layoutElement.addAttribute("delete", String.valueOf(true));
return;
}
portletDataContext.setPlid(layout.getPlid());
if (layout.isIconImage()) {
Image image = ImageLocalServiceUtil.getImage(layout.getIconImageId());
if (image != null) {
String iconPath = getLayoutIconPath(portletDataContext, layout, image);
layoutElement.addElement("icon-image-path").addText(iconPath);
portletDataContext.addZipEntry(iconPath, image.getTextObj());
}
}
_portletExporter.exportPortletData(
portletDataContext, layoutConfigurationPortlet, layout, null, layoutElement);
// Layout permissions
if (exportPermissions) {
_permissionExporter.exportLayoutPermissions(
portletDataContext,
layoutCache,
portletDataContext.getCompanyId(),
portletDataContext.getScopeGroupId(),
layout,
layoutElement,
exportUserPermissions);
}
if (layout.isTypeArticle()) {
exportJournalArticle(portletDataContext, layout, layoutElement);
} else if (layout.isTypeLinkToLayout()) {
UnicodeProperties typeSettingsProperties = layout.getTypeSettingsProperties();
long linkToLayoutId =
GetterUtil.getLong(
typeSettingsProperties.getProperty("linkToLayoutId", StringPool.BLANK));
if (linkToLayoutId > 0) {
try {
Layout linkedToLayout =
LayoutLocalServiceUtil.getLayout(
portletDataContext.getScopeGroupId(), layout.isPrivateLayout(), linkToLayoutId);
exportLayout(
portletDataContext,
layoutConfigurationPortlet,
layoutCache,
portlets,
portletIds,
exportPermissions,
exportUserPermissions,
linkedToLayout,
layoutsElement);
} catch (NoSuchLayoutException nsle) {
}
}
} else if (layout.isTypePortlet()) {
for (Portlet portlet : portlets) {
if (portlet.isScopeable() && layout.hasScopeGroup()) {
String key =
PortletPermissionUtil.getPrimaryKey(layout.getPlid(), portlet.getPortletId());
portletIds.put(
key,
new Object[] {
portlet.getPortletId(),
layout.getPlid(),
layout.getScopeGroup().getGroupId(),
StringPool.BLANK,
layout.getUuid()
});
}
}
LayoutTypePortlet layoutTypePortlet = (LayoutTypePortlet) layout.getLayoutType();
for (String portletId : layoutTypePortlet.getPortletIds()) {
javax.portlet.PortletPreferences jxPreferences =
PortletPreferencesFactoryUtil.getLayoutPortletSetup(layout, portletId);
String scopeType = GetterUtil.getString(jxPreferences.getValue("lfrScopeType", null));
String scopeLayoutUuid =
GetterUtil.getString(jxPreferences.getValue("lfrScopeLayoutUuid", null));
long scopeGroupId = portletDataContext.getScopeGroupId();
if (Validator.isNotNull(scopeType)) {
Group scopeGroup = null;
if (scopeType.equals("company")) {
scopeGroup = GroupLocalServiceUtil.getCompanyGroup(layout.getCompanyId());
} else if (scopeType.equals("layout")) {
Layout scopeLayout = null;
scopeLayout =
LayoutLocalServiceUtil.fetchLayoutByUuidAndGroupId(
scopeLayoutUuid, portletDataContext.getGroupId());
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});
}
}
fixTypeSettings(layout);
layoutElement.addAttribute("path", path);
portletDataContext.addExpando(layoutElement, path, layout);
portletDataContext.addZipEntry(path, layout);
}
public static String getLayoutsJSON(
HttpServletRequest request,
long groupId,
boolean privateLayout,
long parentLayoutId,
long[] expandedLayoutIds)
throws Exception {
ThemeDisplay themeDisplay = (ThemeDisplay) request.getAttribute(WebKeys.THEME_DISPLAY);
JSONArray jsonArray = JSONFactoryUtil.createJSONArray();
List<Layout> layoutAncestors = null;
long selPlid = ParamUtil.getLong(request, "selPlid");
if (selPlid != 0) {
Layout selLayout = LayoutLocalServiceUtil.getLayout(selPlid);
layoutAncestors = selLayout.getAncestors();
}
List<Layout> layouts = getLayouts(request, groupId, privateLayout, parentLayoutId);
for (Layout layout : layouts) {
JSONObject jsonObject = JSONFactoryUtil.createJSONObject();
if ((layoutAncestors != null) && layoutAncestors.contains(layout)
|| ArrayUtil.contains(expandedLayoutIds, layout.getLayoutId())) {
String childrenJSON = StringPool.BLANK;
if (layout instanceof VirtualLayout) {
VirtualLayout virtualLayout = (VirtualLayout) layout;
childrenJSON =
getLayoutsJSON(
request,
virtualLayout.getSourceGroupId(),
virtualLayout.getPrivateLayout(),
virtualLayout.getLayoutId(),
expandedLayoutIds);
} else {
childrenJSON =
getLayoutsJSON(
request,
groupId,
layout.getPrivateLayout(),
layout.getLayoutId(),
expandedLayoutIds);
}
jsonObject.put("children", JSONFactoryUtil.createJSONArray(childrenJSON));
}
jsonObject.put("contentDisplayPage", layout.isContentDisplayPage());
jsonObject.put("friendlyURL", layout.getFriendlyURL());
if (layout instanceof VirtualLayout) {
VirtualLayout virtualLayout = (VirtualLayout) layout;
jsonObject.put("groupId", virtualLayout.getSourceGroupId());
} else {
jsonObject.put("groupId", layout.getGroupId());
}
jsonObject.put("hasChildren", layout.hasChildren());
jsonObject.put("layoutId", layout.getLayoutId());
jsonObject.put("name", layout.getName(themeDisplay.getLocale()));
jsonObject.put("parentLayoutId", layout.getParentLayoutId());
jsonObject.put("plid", layout.getPlid());
jsonObject.put("priority", layout.getPriority());
jsonObject.put("privateLayout", layout.isPrivateLayout());
jsonObject.put("type", layout.getType());
jsonObject.put("updateable", SitesUtil.isLayoutUpdateable(layout));
jsonObject.put("uuid", layout.getUuid());
LayoutRevision layoutRevision = LayoutStagingUtil.getLayoutRevision(layout);
if (layoutRevision != null) {
User user = themeDisplay.getUser();
long recentLayoutSetBranchId =
StagingUtil.getRecentLayoutSetBranchId(user, layout.getLayoutSet().getLayoutSetId());
if (StagingUtil.isIncomplete(layout, recentLayoutSetBranchId)) {
jsonObject.put("incomplete", true);
}
long layoutSetBranchId = layoutRevision.getLayoutSetBranchId();
LayoutSetBranch layoutSetBranch =
LayoutSetBranchLocalServiceUtil.getLayoutSetBranch(layoutSetBranchId);
LayoutBranch layoutBranch = layoutRevision.getLayoutBranch();
if (!layoutBranch.isMaster()) {
jsonObject.put("layoutBranchId", layoutBranch.getLayoutBranchId());
jsonObject.put("layoutBranchName", layoutBranch.getName());
}
jsonObject.put("layoutRevisionId", layoutRevision.getLayoutRevisionId());
jsonObject.put("layoutSetBranchId", layoutSetBranchId);
jsonObject.put("layoutSetBranchName", layoutSetBranch.getName());
}
jsonArray.put(jsonObject);
}
return jsonArray.toString();
}
