org.opencms.ui.components.fileselect.CmsResourceSelectDialog 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, 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.ui.components.fileselect;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.main.CmsException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.site.CmsSite;
import org.opencms.ui.A_CmsUI;
import org.opencms.ui.CmsVaadinUtils;
import org.opencms.util.CmsStringUtil;
import org.opencms.util.CmsUUID;
import org.opencms.workplace.CmsWorkplace;
import java.util.Collections;
import java.util.List;
import org.apache.commons.logging.Log;
import com.google.common.collect.Lists;
import com.vaadin.data.Property.ValueChangeEvent;
import com.vaadin.data.Property.ValueChangeListener;
import com.vaadin.shared.ui.combobox.FilteringMode;
import com.vaadin.ui.ComboBox;
import com.vaadin.ui.Component;
import com.vaadin.ui.CustomComponent;
/**
* Dialog with a site selector and file tree which can be used to select resources.
*/
public class CmsResourceSelectDialog extends CustomComponent {
/**
* Converts resource selection to path (string) selection - either as root paths or site paths.
*/
class PathSelectionAdapter implements I_CmsSelectionHandler {
/** The wrapped string selection handler. */
private I_CmsSelectionHandler m_pathHandler;
/** If true, pass site paths to the wrapped path handler, else root paths. */
private boolean m_useSitePaths;
/**
* Creates a new instance.
*
* @param pathHandler the selection handler to call
* @param useSitePaths true if we want changes as site paths
*/
public PathSelectionAdapter(I_CmsSelectionHandler pathHandler, boolean useSitePaths) {
m_pathHandler = pathHandler;
m_useSitePaths = useSitePaths;
}
/**
* @see org.opencms.ui.components.fileselect.I_CmsSelectionHandler#onSelection(java.lang.Object)
*/
@SuppressWarnings("synthetic-access")
public void onSelection(CmsResource selected) {
String path = selected.getRootPath();
if (m_useSitePaths) {
try {
CmsObject cms = OpenCms.initCmsObject(A_CmsUI.getCmsObject());
cms.getRequestContext().setSiteRoot(m_siteRoot);
path = cms.getRequestContext().removeSiteRoot(path);
} catch (CmsException e) {
LOG.error(e.getLocalizedMessage(), e);
}
}
m_pathHandler.onSelection(path);
}
}
/** The property used for the site caption. */
public static final String PROPERTY_SITE_CAPTION = "caption";
/** Logger instance for this class. */
private static final Log LOG = CmsLog.getLog(CmsResourceSelectDialog.class);
/** Serial version id. */
private static final long serialVersionUID = 1L;
/** The CMS context. */
protected CmsObject m_currentCms;
/** The resource filter. */
protected CmsResourceFilter m_filter;
/** The resource initially displayed at the root of the tree. */
protected CmsResource m_root;
/** The file tree (wrapped in an array, because Vaadin Declarative tries to bind it otherwise) .*/
private CmsResourceTreeTable m_fileTree;
/** Boolean flag indicating whether the tree is currently filtered. */
private boolean m_isSitemapView = true;
/** The site root. */
private String m_siteRoot;
/** Contains the data for the tree. */
private CmsResourceTreeContainer m_treeData;
/**
* Creates a new instance.
*
* @param filter the resource filter to use
*
* @throws CmsException if something goes wrong
*/
public CmsResourceSelectDialog(CmsResourceFilter filter)
throws CmsException {
m_filter = filter;
CmsObject cms = A_CmsUI.getCmsObject();
setCompositionRoot(new CmsResourceSelectDialogContents());
getSiteSelector().setContainerDataSource(CmsVaadinUtils.getAvailableSitesContainer(cms, PROPERTY_SITE_CAPTION));
m_siteRoot = cms.getRequestContext().getSiteRoot();
getSiteSelector().setValue(m_siteRoot);
getSiteSelector().setNullSelectionAllowed(false);
getSiteSelector().setItemCaptionPropertyId(PROPERTY_SITE_CAPTION);
getSiteSelector().setFilteringMode(FilteringMode.CONTAINS);
getSiteSelector().addValueChangeListener(new ValueChangeListener() {
/** Serial version id. */
private static final long serialVersionUID = 1L;
public void valueChange(ValueChangeEvent event) {
String site = (String)(event.getProperty().getValue());
onSiteChange(site);
}
});
CmsResource root = cms.readResource("/");
m_fileTree = createTree(cms, root);
m_treeData = m_fileTree.getTreeContainer();
updateRoot(cms, root);
getContents().getTreeContainer().addComponent(m_fileTree);
((Component)m_fileTree).setSizeFull();
updateView();
}
/**
* Adds a resource selection handler.
*
* @param handler the handler
*/
public void addSelectionHandler(I_CmsSelectionHandler handler) {
m_fileTree.addResourceSelectionHandler(handler);
}
/**
* Opens the given path.
*
* @param path the path to open
*/
public void openPath(String path) {
if (!CmsStringUtil.isPrefixPath(m_root.getRootPath(), path)) {
CmsSite site = OpenCms.getSiteManager().getSiteForRootPath(path);
if (site != null) {
// the given path is a root path switch to the determined site
getSiteSelector().setValue(site.getSiteRoot());
path = m_currentCms.getRequestContext().removeSiteRoot(path);
} else if (OpenCms.getSiteManager().startsWithShared(path)) {
getSiteSelector().setValue(OpenCms.getSiteManager().getSharedFolder());
} else if (path.startsWith(CmsWorkplace.VFS_PATH_SYSTEM)) {
getSiteSelector().setValue("");
}
}
if (!"/".equals(path)) {
List idsToOpen = Lists.newArrayList();
try {
CmsResource currentFolder = m_currentCms.readResource(CmsResource.getParentFolder(path));
if (!m_root.getStructureId().equals(currentFolder.getStructureId())) {
idsToOpen.add(currentFolder.getStructureId());
CmsResource parentFolder = null;
do {
try {
parentFolder = m_currentCms.readParentFolder(currentFolder.getStructureId());
idsToOpen.add(parentFolder.getStructureId());
currentFolder = parentFolder;
} catch (CmsException e) {
LOG.info(e.getLocalizedMessage(), e);
break;
}
} while (!parentFolder.getStructureId().equals(m_root.getStructureId()));
// we need to iterate from "top" to "bottom", so we reverse the list of folders
Collections.reverse(idsToOpen);
for (CmsUUID id : idsToOpen) {
m_fileTree.expandItem(id);
}
}
} catch (CmsException e) {
LOG.debug("Can not read parent folder of current path.", e);
}
}
}
/**
* Switches between the folders and sitemap view of the tree.
*
* @param showSitemapView true to show the sitemap view
*/
public void showSitemapView(boolean showSitemapView) {
if (m_isSitemapView != showSitemapView) {
m_isSitemapView = showSitemapView;
updateView();
}
}
/**
* Displays the start resource by opening all nodes in the tree leading to it.
*
* @param startResource the resource which should be shown in the tree
*/
public void showStartResource(CmsResource startResource) {
openPath(startResource.getRootPath());
}
/**
* Creates the resource tree for the given root.
*
* @param cms the CMS context
* @param root the root resource
* @return the resource tree
*/
protected CmsResourceTreeTable createTree(CmsObject cms, CmsResource root) {
return new CmsResourceTreeTable(cms, root, m_filter);
}
/**
* Gets the content panel of this dialog.
*
* @return content panel of this dialog
*/
protected CmsResourceSelectDialogContents getContents() {
return ((CmsResourceSelectDialogContents)getCompositionRoot());
}
/**
* Gets the file tree.
*
* @return the file tree
*/
protected CmsResourceTreeTable getFileTree() {
return m_fileTree;
}
/**
* Called when the user changes the site.
*
* @param site the new site root
*/
protected void onSiteChange(String site) {
try {
m_treeData.removeAllItems();
CmsObject rootCms = OpenCms.initCmsObject(A_CmsUI.getCmsObject());
rootCms.getRequestContext().setSiteRoot("");
CmsResource siteRootResource = rootCms.readResource(site);
m_treeData.initRoot(rootCms, siteRootResource);
m_fileTree.expandItem(siteRootResource.getStructureId());
m_siteRoot = site;
updateRoot(rootCms, siteRootResource);
} catch (CmsException e) {
LOG.error(e.getLocalizedMessage(), e);
}
}
/**
* Updates the current site root resource.
*
* @param rootCms the CMS context
* @param siteRootResource the resource corresponding to a site root
*/
protected void updateRoot(CmsObject rootCms, CmsResource siteRootResource) {
m_root = siteRootResource;
m_currentCms = rootCms;
updateView();
}
/**
* Updates the filtering state.
*/
protected void updateView() {
m_fileTree.showSitemapView(m_isSitemapView);
}
/**
* Gets the site selector.
*
* @return the site selector
*/
private ComboBox getSiteSelector() {
return getContents().getSiteSelector();
}
}