org.opencms.workplace.CmsWorkplaceSettings Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.workplace;
import org.opencms.ade.galleries.shared.CmsGallerySearchScope;
import org.opencms.ade.galleries.shared.I_CmsGalleryProviderConstants.SortParams;
import org.opencms.db.CmsPublishList;
import org.opencms.db.CmsUserSettings;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsUser;
import org.opencms.file.collectors.I_CmsResourceCollector;
import org.opencms.i18n.CmsMessageContainer;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.util.CmsUUID;
import org.opencms.workplace.tools.CmsToolUserData;
import java.util.HashMap;
import java.util.Map;
import org.apache.commons.logging.Log;
/**
* Object to conveniently access and modify the state of the workplace for a user,
* will be stored in the session of a user.
*
* @since 6.0.0
*/
public class CmsWorkplaceSettings {
/** Log instance for this class. */
private static final Log LOG = CmsLog.getLog(CmsWorkplaceSettings.class);
/** The resource collector. */
private I_CmsResourceCollector m_collector;
/** The current site. */
private String m_currentSite;
/** The diaolg object. */
private Object m_dialogObject;
/** The error messages. */
private CmsMessageContainer m_errorMessage;
/** The explorer URL. */
private String m_explorerFlaturl;
/** The explorer mode. */
private String m_explorerMode;
/** The explorer page. */
private int m_explorerPage;
/** The explorer project filter. */
private String m_explorerProjectFilter;
/** The explorer project id. */
private CmsUUID m_explorerProjectId;
/** The explorer resource. */
private Map m_explorerResource;
/** The frame URIs. */
private Map m_frameUris;
/** The gallery type. */
private String m_galleryType;
/** The last sort order used for the gallery search results. */
private SortParams m_lastGalleryResultOrder;
/** The last used galleries. */
private Map m_lastUsedGalleries;
/** The list object. */
private Object m_listObject;
/** The permission detail view. */
private String m_permissionDetailView;
/** The project id. */
private CmsUUID m_project;
/** The publish list. */
private CmsPublishList m_publishList;
/** The gallery search scope. */
private CmsGallerySearchScope m_scope;
/** The tool user data. */
private CmsToolUserData m_toolUserData;
/** The tree site. */
private Map m_treeSite;
/** The tree type. */
private Map m_treeType;
/** The user. */
private CmsUser m_user;
/** The user agreement accepted flag. */
private boolean m_userAgreementAccepted;
/** The user settings. */
private CmsUserSettings m_userSettings;
/** The startup view. */
private String m_viewStartup;
/** The view URI. */
private String m_viewUri;
/**
* Constructor, only package visible.
*/
CmsWorkplaceSettings() {
m_explorerPage = 1;
m_explorerResource = new HashMap();
m_treeType = new HashMap();
m_treeSite = new HashMap();
m_frameUris = new HashMap();
m_lastUsedGalleries = new HashMap();
m_currentSite = OpenCms.getSiteManager().getDefaultSite().getSiteRoot();
}
/**
* Returns the collector object.
*
* Use this mechanism for transferring a resource collector between
* several page instances of an interactive dialog.
*
* @return the dialog object
*/
public I_CmsResourceCollector getCollector() {
return m_collector;
}
/**
* Returns the dialog object.
*
* Use this mechanism for transferring a complex object between
* several page instances of an interactive dialog. This is usually
* required when editing a complex object in a dialog of the "Administration" view.
*
* @return the dialog object
*/
public Object getDialogObject() {
return m_dialogObject;
}
/**
* Returns the error message to display in the workplace.
*
* @return the error message to display in the workplace
*/
public CmsMessageContainer getErrorMessage() {
return m_errorMessage;
}
/**
* Returns the explorer flat url.
*
* @return the explorer flat url
*/
public String getExplorerFlaturl() {
return m_explorerFlaturl;
}
/**
* Returns the current explorer mode.
*
* @return the current explorer mode
*/
public String getExplorerMode() {
return m_explorerMode;
}
/**
* Returns the currently selected page in the explorer view.
*
* @return the currently selected page in the explorer view
*/
public int getExplorerPage() {
return m_explorerPage;
}
/**
* Gets the explorer project filter for the project view.
*
* This parameter is used in the administration to filter
* files belonging to a project.
*
* @return the explorer project filter
*/
public String getExplorerProjectFilter() {
return m_explorerProjectFilter;
}
/**
* Gets the explorer project id for the project view.
*
* This parameter is used in the administration to filter
* files belonging to a selected project.
*
* @return the explorer project id
*/
public CmsUUID getExplorerProjectId() {
return m_explorerProjectId;
}
/**
* Returns the current resource to be displayed in the explorer.
*
* @return the current resource to be displayed in the explorer
*/
public String getExplorerResource() {
// get the current explorer mode
String mode = getExplorerMode();
if (mode == null) {
mode = CmsWorkplace.VIEW_EXPLORER;
}
if (CmsWorkplace.VIEW_EXPLORER.equals(mode)) {
// append the current site to the key when in explorer view mode
mode += "_" + getSite() + "/";
}
// get the resource for the given mode
String resource = m_explorerResource.get(mode);
if (resource == null) {
resource = "/";
}
return resource;
}
/**
* Returns the frame URIs of the currently loaded frameset, with the frame names as keys.
*
* @return the frame URIs of the currently loaded frameset
*/
public Map getFrameUris() {
return m_frameUris;
}
/**
* Returns the current gallery type name.
*
* @return the current gallery type name
*/
public String getGalleryType() {
return m_galleryType;
}
/**
* Gets the last result sort order for the gallery dialog.
*
* @return the last sort order
*/
public SortParams getLastGalleryResultOrder() {
if (m_lastGalleryResultOrder == null) {
return SortParams.dateLastModified_desc;
}
return m_lastGalleryResultOrder;
}
/**
* Returns the last gallery search scope.
*
* @return the last gallery search scope
*/
public CmsGallerySearchScope getLastSearchScope() {
if (m_scope == null) {
return OpenCms.getWorkplaceManager().getGalleryDefaultScope();
}
return m_scope;
}
/**
* Returns the last saved gallery for the given gallery key.
*
* @param galleryKey the key for which to look up the gallery
* @return the last saved gallery for the given gallery key
**/
public String getLastUsedGallery(String galleryKey) {
String result = m_lastUsedGalleries.get(galleryKey);
LOG.info("user=" + m_user.getName() + ": getLastUsedGallery " + galleryKey + " : returning " + result);
return result;
}
/**
* Returns the list dialog object.
*
* Use this mechanism for transfering a html list object between
* several page instances of an interactive dialog. This is usually
* required when having several lists in a tool or when a list action
* another list displays of the "Administration" view.
*
* @return the dialog object
*
* @see org.opencms.workplace.list.A_CmsListDialog#getListObject(Class, CmsWorkplaceSettings)
*/
public Object getListObject() {
return m_listObject;
}
/**
* Returns the current detail grade of the view.
*
* @return value of the details.
*/
public String getPermissionDetailView() {
return m_permissionDetailView;
}
/**
* Returns the currently selected project of the workplace user.
*
* @return the currently selected project of the workplace user
*/
public CmsUUID getProject() {
return m_project;
}
/**
* Returns the publish list.
*
* @return the publishList
*/
public CmsPublishList getPublishList() {
return m_publishList;
}
/**
* Returns the current site for the user.
*
* @return the current site for the user
*/
public String getSite() {
return m_currentSite;
}
/**
* Returns the new admin view tool User Data.
*
* @return the tool User Data
*/
public CmsToolUserData getToolUserData() {
return m_toolUserData;
}
/**
* Returns the tree resource uri for the specified tree type.
*
* @param type the type of the tree
* @return the tree resource uri for the specified tree type
*/
public String getTreeResource(String type) {
String result = m_treeType.get(type);
if (result == null) {
result = "/";
}
return result;
}
/**
* Returns the tree site uri for the specified tree type.
*
* @param type the type of the tree
* @return the tree site uri for the specified tree type
*/
public String getTreeSite(String type) {
String result = m_treeSite.get(type);
return result;
}
/**
* Returns the current workplace user.
*
* @return the current workplace user
*/
public CmsUser getUser() {
return m_user;
}
/**
* Returns the current workplace user settings object.
*
* @return the current workplace user settings object
*/
public CmsUserSettings getUserSettings() {
return m_userSettings;
}
/**
* Returns the view startup page.
*
* The view startup page can be used to directly load a specific workplace dialog or other workplace resource in the
* OpenCms workplace base frameset after the user logs in.
*
* @return the view startup page
*/
public String getViewStartup() {
return m_viewStartup;
}
/**
* Returns the current view Uri selected in the workplace.
*
* @return the current view Uri selected in the workplace
*/
public String getViewUri() {
return m_viewUri;
}
/**
* Returns if the user agreement has been accepted in the current workplace session.
*
* @return true if the user agreement has been accepted in the current workplace session, otherwise false
*/
public boolean isUserAgreementAccepted() {
return m_userAgreementAccepted;
}
/**
* Checks if the current view is the explorer view.
*
* @return true if the current view is the explorer view, otherwise false
*/
public boolean isViewExplorer() {
return getViewUri().endsWith(CmsWorkplace.FILE_EXPLORER_FILELIST);
}
/**
* Sets the collector object.
*
* Use this mechanism for transferring a resource collector between
* several page instances of an interactive dialog.
*
* @param collector the dialog object to set
*/
public void setCollector(I_CmsResourceCollector collector) {
m_collector = collector;
}
/**
* Sets the dialog object.
*
* Use this mechanism for transferring a complex object between
* several page instances of an interactive dialog. This is usually
* required when editing a complex object in a dialog of the "Administration" view.
*
* @param dialogObject the dialog object to set
*/
public void setDialogObject(Object dialogObject) {
m_dialogObject = dialogObject;
}
/**
* Sets the error message to display in the workplace.
*
* @param errorMessage the error message to display in the workplace
*/
public void setErrorMessage(CmsMessageContainer errorMessage) {
m_errorMessage = errorMessage;
}
/**
* Sets the explorer flat url.
*
* @param value the explorer flat url
*/
public void setExplorerFlaturl(String value) {
m_explorerFlaturl = value;
}
/**
* Sets the current explorer mode.
*
* @param value the current explorer mode
*/
public void setExplorerMode(String value) {
m_explorerMode = value;
}
/**
* Sets the currently selected page in the explorer view.
*
* @param page the currently selected page in the explorer view
*/
public void setExplorerPage(int page) {
m_explorerPage = page;
}
/**
* Sets the explorer project filter for the project view.
*
* @param value the explorer project filter
*/
public void setExplorerProjectFilter(String value) {
m_explorerProjectFilter = value;
}
/**
* Sets the explorer project id for the project view.
*
* @param value the explorer project id
*/
public void setExplorerProjectId(CmsUUID value) {
m_explorerProjectId = value;
}
/**
* Sets the current resource to be displayed in the explorer.
*
* @param value the current resource to be displayed in the explorer
*
* @deprecated use {@link #setExplorerResource(String, CmsObject)} instead
*/
@Deprecated
public void setExplorerResource(String value) {
setExplorerResource(value, null);
}
/**
* Sets the current resource to be displayed in the explorer.
*
* @param value the current resource to be displayed in the explorer
*
* @param cms needed for validation / normalization of the given path
*/
public void setExplorerResource(String value, CmsObject cms) {
if (value == null) {
return;
}
// get the current explorer mode
String mode = getExplorerMode();
if (mode == null) {
mode = CmsWorkplace.VIEW_EXPLORER;
}
if (CmsWorkplace.VIEW_EXPLORER.equals(mode)) {
// append the current site to the key when in explorer view mode
mode += "_" + getSite() + "/";
}
// set the resource for the given mode
if (value.startsWith(CmsResource.VFS_FOLDER_SYSTEM + "/")
&& (!value.startsWith(m_currentSite))
&& (!CmsWorkplace.VIEW_GALLERY.equals(getExplorerMode()))) {
// restrict access to /system/
m_explorerResource.put(mode, "/");
} else {
if (cms != null) {
// Validation with read resource has 2 advantages:
// 1: Normalization of the path: a missing trailing slash is not fatal.
// 2: existence is verified.
try {
CmsResource resource = cms.readResource(value);
value = cms.getSitePath(resource);
} catch (CmsException cme) {
// nop
}
}
m_explorerResource.put(mode, value);
}
}
/**
* Sets the current gallery type name.
*
* @param currentGallery the current gallery type name to set
*/
public void setGalleryType(String currentGallery) {
m_galleryType = currentGallery;
}
/**
* Sets the last sort order used for the gallery results.
*
* @param order the last sort order
*/
public void setLastGalleryResultOrder(SortParams order) {
m_lastGalleryResultOrder = order;
}
/**
* Sets the last gallery search scope.
*
* @param scope the gallery search scope
*/
public void setLastSearchScope(CmsGallerySearchScope scope) {
m_scope = scope;
}
/**
* Saves the last gallery for a given key.
*
* @param galleryKey the gallery key
* @param gallerypath the resourcepath of the gallery
*/
public void setLastUsedGallery(String galleryKey, String gallerypath) {
m_lastUsedGalleries.put(galleryKey, gallerypath);
LOG.info("user=" + m_user.getName() + ": setLastUsedGallery " + galleryKey + " -> " + gallerypath);
}
/**
* Sets the list object.
*
* Use this mechanism for transfering a html list object between
* several page instances of an interactive dialog. This is usually
* required when having several lists in a tool or when a list action
* another list displays of the "Administration" view.
*
* @param listObject the list object to set
*
* @see org.opencms.workplace.list.A_CmsListDialog#setListObject(Class, org.opencms.workplace.list.CmsHtmlList)
*/
public void setListObject(Object listObject) {
m_listObject = listObject;
}
/**
* Sets the current detail grade of the view.
*
* @param value the current details.
*/
public void setPermissionDetailView(String value) {
m_permissionDetailView = value;
}
/**
* Sets the currently selected project of the workplace user.
*
* @param project the currently selected project of thw workplace user
*/
public void setProject(CmsUUID project) {
m_project = project;
}
/**
* Sets the publish list.
*
* @param publishList the publishList to set
*/
public void setPublishList(CmsPublishList publishList) {
m_publishList = publishList;
}
/**
* Sets the current site for the user.
*
* @param value the current site for the user
*/
public void setSite(String value) {
if ((value != null) && !value.equals(m_currentSite)) {
m_currentSite = value;
m_treeType = new HashMap();
}
}
/**
* Sets the new admin view tool User Data.
*
* @param toolUserData the tool User Data to set
*/
public void setToolUserData(CmsToolUserData toolUserData) {
m_toolUserData = toolUserData;
}
/**
* Sets the tree resource uri for the specified tree type.
*
* @param type the type of the tree
* @param value the resource uri to set for the type
*/
public void setTreeResource(String type, String value) {
if (value == null) {
return;
}
if (value.startsWith(CmsResource.VFS_FOLDER_SYSTEM + "/") && (!value.startsWith(m_currentSite))) {
// restrict access to /system/
value = "/";
}
m_treeType.put(type, value);
}
/**
* Sets the tree resource uri for the specified tree type.
*
* @param type the type of the tree
* @param value the resource uri to set for the type
*/
public void setTreeSite(String type, String value) {
if (value == null) {
return;
}
m_treeSite.put(type, value);
}
/**
* Sets the current workplace user.
*
* @param user the current workplace user
*/
public void setUser(CmsUser user) {
m_user = user;
}
/**
* Sets if the user agreement has been accepted in the current workplace session.
*
* @param userAgreementAccepted true if the user agreement has been accepted in the current workplace session, otherwise false
*/
public void setUserAgreementAccepted(boolean userAgreementAccepted) {
m_userAgreementAccepted = userAgreementAccepted;
}
/**
* Sets the current workplace user settings object.
*
* @param userSettings the current workplace user settings object
*/
public void setUserSettings(CmsUserSettings userSettings) {
m_userSettings = userSettings;
}
/**
* Sets the view startup page.
*
* The view startup page can be used to directly load a specific workplace dialog or other workplace resource in the
* OpenCms workplace base frameset after the user logs in.
*
* @param viewStartup the view startup page to set
*/
public void setViewStartup(String viewStartup) {
m_viewStartup = viewStartup;
}
/**
* Sets the view Uri for the workplace.
*
* @param string the view Uri for the workplace
*/
public void setViewUri(String string) {
m_viewUri = string;
}
}