org.opencms.ui.apps.CmsFileExplorer 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 (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.apps;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsProject;
import org.opencms.file.CmsProperty;
import org.opencms.file.CmsPropertyDefinition;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.file.CmsVfsResourceNotFoundException;
import org.opencms.lock.CmsLockActionRecord;
import org.opencms.lock.CmsLockActionRecord.LockChange;
import org.opencms.lock.CmsLockException;
import org.opencms.lock.CmsLockUtil;
import org.opencms.main.CmsException;
import org.opencms.main.CmsIllegalArgumentException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.security.CmsPermissionSet;
import org.opencms.ui.A_CmsUI;
import org.opencms.ui.CmsVaadinUtils;
import org.opencms.ui.FontOpenCms;
import org.opencms.ui.I_CmsContextMenuBuilder;
import org.opencms.ui.I_CmsDialogContext;
import org.opencms.ui.I_CmsUpdateListener;
import org.opencms.ui.actions.CmsCopyMoveDialogAction;
import org.opencms.ui.actions.CmsPropertiesDialogAction;
import org.opencms.ui.actions.I_CmsWorkplaceAction;
import org.opencms.ui.components.A_CmsFocusShortcutListener;
import org.opencms.ui.components.CmsErrorDialog;
import org.opencms.ui.components.CmsFileTable;
import org.opencms.ui.components.CmsResourceTableProperty;
import org.opencms.ui.components.CmsToolBar;
import org.opencms.ui.components.CmsUploadButton;
import org.opencms.ui.components.CmsUploadButton.I_UploadListener;
import org.opencms.ui.components.I_CmsFilePropertyEditHandler;
import org.opencms.ui.components.I_CmsWindowCloseListener;
import org.opencms.ui.components.OpenCmsTheme;
import org.opencms.ui.components.contextmenu.CmsContextMenu;
import org.opencms.ui.components.contextmenu.CmsContextMenu.ContextMenuItem;
import org.opencms.ui.components.contextmenu.CmsContextMenu.ContextMenuItemClickEvent;
import org.opencms.ui.components.contextmenu.CmsContextMenu.ContextMenuItemClickListener;
import org.opencms.ui.components.extensions.CmsUploadAreaExtension;
import org.opencms.ui.contextmenu.CmsContextMenuTreeBuilder;
import org.opencms.ui.contextmenu.I_CmsContextMenuItem;
import org.opencms.ui.dialogs.CmsCopyMoveDialog;
import org.opencms.ui.dialogs.CmsDeleteDialog;
import org.opencms.ui.dialogs.CmsNewDialog;
import org.opencms.util.CmsStringUtil;
import org.opencms.util.CmsTreeNode;
import org.opencms.util.CmsUUID;
import org.opencms.workplace.explorer.CmsResourceUtil;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.commons.logging.Log;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import com.vaadin.data.Item;
import com.vaadin.data.Property.ValueChangeEvent;
import com.vaadin.data.Property.ValueChangeListener;
import com.vaadin.data.util.HierarchicalContainer;
import com.vaadin.data.util.IndexedContainer;
import com.vaadin.event.Action;
import com.vaadin.event.FieldEvents.BlurEvent;
import com.vaadin.event.FieldEvents.FocusEvent;
import com.vaadin.event.FieldEvents.TextChangeEvent;
import com.vaadin.event.FieldEvents.TextChangeListener;
import com.vaadin.event.ItemClickEvent;
import com.vaadin.event.ItemClickEvent.ItemClickListener;
import com.vaadin.event.ShortcutAction;
import com.vaadin.event.ShortcutAction.KeyCode;
import com.vaadin.event.dd.DragAndDropEvent;
import com.vaadin.event.dd.DropHandler;
import com.vaadin.event.dd.acceptcriteria.AcceptCriterion;
import com.vaadin.event.dd.acceptcriteria.ServerSideCriterion;
import com.vaadin.navigator.ViewChangeListener;
import com.vaadin.server.AbstractErrorMessage.ContentMode;
import com.vaadin.server.ExternalResource;
import com.vaadin.server.Page;
import com.vaadin.server.Sizeable.Unit;
import com.vaadin.server.UserError;
import com.vaadin.shared.MouseEventDetails.MouseButton;
import com.vaadin.shared.ui.combobox.FilteringMode;
import com.vaadin.ui.AbstractSelect.AbstractSelectTargetDetails;
import com.vaadin.ui.Button;
import com.vaadin.ui.Button.ClickEvent;
import com.vaadin.ui.Button.ClickListener;
import com.vaadin.ui.ComboBox;
import com.vaadin.ui.CssLayout;
import com.vaadin.ui.HorizontalLayout;
import com.vaadin.ui.HorizontalSplitPanel;
import com.vaadin.ui.Table;
import com.vaadin.ui.Table.TableDragMode;
import com.vaadin.ui.TextField;
import com.vaadin.ui.Tree;
import com.vaadin.ui.Tree.CollapseEvent;
import com.vaadin.ui.Tree.CollapseListener;
import com.vaadin.ui.Tree.ExpandEvent;
import com.vaadin.ui.Tree.ExpandListener;
import com.vaadin.ui.Tree.ItemStyleGenerator;
import com.vaadin.ui.Tree.TreeDragMode;
import com.vaadin.ui.UI;
import com.vaadin.ui.themes.ValoTheme;
/**
* The file explorer app.
*/
public class CmsFileExplorer
implements I_CmsWorkplaceApp, I_CmsCachableApp, ViewChangeListener, I_CmsWindowCloseListener, I_CmsHasShortcutActions {
/**
* Handles inline editing within the file table.
*/
public class ContextMenuEditHandler implements I_CmsFilePropertyEditHandler {
/** The serial version id. */
private static final long serialVersionUID = -9160838301862765592L;
/** The edited content structure id. */
private CmsUUID m_editId;
/** The edited property. */
private CmsResourceTableProperty m_editProperty;
/** The lock action record. */
private CmsLockActionRecord m_lockActionRecord;
/**
* Constructor.
*
* @param editId the content structure id
* @param editProperty the property to edit
*/
public ContextMenuEditHandler(CmsUUID editId, CmsResourceTableProperty editProperty) {
m_editId = editId;
m_editProperty = editProperty;
}
/**
* Cancels the edit process. Unlocks the resource if required.
*
* @see org.opencms.ui.components.I_CmsFilePropertyEditHandler#cancel()
*/
public void cancel() {
if (m_lockActionRecord.getChange() == LockChange.locked) {
CmsObject cms = A_CmsUI.getCmsObject();
try {
CmsResource res = cms.readResource(m_editId);
cms.unlockResource(res);
} catch (CmsException e) {
LOG.warn("Failed to unlock resource " + m_editId.toString(), e);
}
}
CmsAppWorkplaceUi.get().enableGlobalShortcuts();
}
/**
* @see org.opencms.ui.components.I_CmsFilePropertyEditHandler#save(java.lang.String)
*/
public void save(String value) {
try {
CmsObject cms = A_CmsUI.getCmsObject();
CmsResource res = cms.readResource(m_editId);
try {
if (CmsResourceTableProperty.PROPERTY_NAVIGATION_TEXT.equals(m_editProperty)
|| CmsResourceTableProperty.PROPERTY_TITLE.equals(m_editProperty)) {
CmsProperty prop = new CmsProperty(
m_editProperty == CmsResourceTableProperty.PROPERTY_NAVIGATION_TEXT
? CmsPropertyDefinition.PROPERTY_NAVTEXT
: CmsPropertyDefinition.PROPERTY_TITLE,
value,
null);
cms.writePropertyObject(cms.getSitePath(res), prop);
} else if (CmsResourceTableProperty.PROPERTY_RESOURCE_NAME.equals(m_editProperty)) {
String sourcePath = cms.getSitePath(res);
cms.renameResource(
sourcePath,
CmsStringUtil.joinPaths(CmsResource.getParentFolder(sourcePath), value));
}
} finally {
if (m_lockActionRecord.getChange() == LockChange.locked) {
CmsResource updatedRes = cms.readResource(res.getStructureId(), CmsResourceFilter.ALL);
try {
cms.unlockResource(updatedRes);
} catch (CmsLockException e) {
LOG.warn(e.getLocalizedMessage(), e);
}
}
CmsAppWorkplaceUi.get().enableGlobalShortcuts();
m_fileTable.clearSelection();
}
} catch (CmsException e) {
LOG.error("Exception while saving changed " + m_editProperty + " to resource " + m_editId, e);
CmsErrorDialog.showErrorDialog(e);
}
}
/**
* @see org.opencms.ui.components.I_CmsFilePropertyEditHandler#start()
*/
public void start() {
CmsObject cms = A_CmsUI.getCmsObject();
try {
CmsResource res = cms.readResource(m_editId);
m_lockActionRecord = CmsLockUtil.ensureLock(cms, res);
CmsAppWorkplaceUi.get().disableGlobalShortcuts();
m_fileTable.startEdit(m_editId, m_editProperty, this);
} catch (CmsException e) {
CmsErrorDialog.showErrorDialog(e);
LOG.debug(e.getLocalizedMessage(), e);
}
}
/**
* @see com.vaadin.event.FieldEvents.TextChangeListener#textChange(com.vaadin.event.FieldEvents.TextChangeEvent)
*/
public void textChange(TextChangeEvent event) {
TextField tf = (TextField)event.getSource();
try {
validate(event.getText());
tf.setComponentError(null);
} catch (InvalidValueException e) {
tf.setComponentError(new UserError(e.getHtmlMessage(), ContentMode.HTML, null));
}
}
/**
* @see com.vaadin.data.Validator#validate(java.lang.Object)
*/
public void validate(Object value) throws InvalidValueException {
if ((m_editProperty == CmsResourceTableProperty.PROPERTY_RESOURCE_NAME) && (value instanceof String)) {
try {
String newName = (String)value;
CmsResource.checkResourceName(newName);
CmsObject cms = A_CmsUI.getCmsObject();
CmsResource res = cms.readResource(m_editId);
if (!res.getName().equals(newName)) {
String sourcePath = cms.getSitePath(res);
if (cms.existsResource(
CmsStringUtil.joinPaths(CmsResource.getParentFolder(sourcePath), newName))) {
throw new InvalidValueException("The selected filename already exists.");
}
}
} catch (CmsIllegalArgumentException e) {
throw new InvalidValueException(e.getLocalizedMessage(A_CmsUI.get().getLocale()));
} catch (CmsException e) {
LOG.warn("Error while validating new filename", e);
throw new InvalidValueException(e.getLocalizedMessage(A_CmsUI.get().getLocale()));
}
}
}
}
/** The drop handler for copy/move operations. */
public class ExplorerDropHandler implements DropHandler {
/** The serial version id. */
private static final long serialVersionUID = 5392136127699472654L;
/** The copy move action. */
final I_CmsWorkplaceAction m_copyMoveAction = new CmsCopyMoveDialogAction();
/**
* @see com.vaadin.event.dd.DropHandler#drop(com.vaadin.event.dd.DragAndDropEvent)
*/
public void drop(DragAndDropEvent dragEvent) {
try {
CmsExplorerDialogContext context = getContext(dragEvent);
if (m_copyMoveAction.isActive(context)) {
CmsCopyMoveDialog dialog = new CmsCopyMoveDialog(context);
dialog.setTargetFolder(getTargetId(dragEvent));
context.start(m_copyMoveAction.getTitle(), dialog);
}
} catch (Exception e) {
LOG.error("Moving resource failed", e);
}
}
/**
* @see com.vaadin.event.dd.DropHandler#getAcceptCriterion()
*/
public AcceptCriterion getAcceptCriterion() {
return new ServerSideCriterion() {
private static final long serialVersionUID = 1L;
public boolean accept(DragAndDropEvent dragEvent) {
try {
if (!m_copyMoveAction.isActive(getContext(dragEvent))) {
return false;
}
} catch (CmsException e) {
LOG.error("Drag an drop evaluation failed", e);
return false;
}
CmsUUID targetId = getTargetId(dragEvent);
return mayDrop(targetId);
}
};
}
/**
* Returns the drag target id.
*
* @param dragEvent the drag event
*
* @return the drag target id
*/
protected CmsUUID getTargetId(DragAndDropEvent dragEvent) {
CmsUUID targetId = null;
if (dragEvent.getTargetDetails() instanceof AbstractSelectTargetDetails) {
AbstractSelectTargetDetails target = (AbstractSelectTargetDetails)dragEvent.getTargetDetails();
targetId = (CmsUUID)target.getItemIdOver();
}
try {
CmsObject cms = A_CmsUI.getCmsObject();
CmsResource target = cms.readResource(targetId);
if (target.isFile()) {
targetId = null;
}
} catch (CmsException e) {
targetId = null;
LOG.debug("Checking drop target failed, use current folder.", e);
}
if (targetId == null) {
targetId = getCurrentFolder();
}
return targetId;
}
/**
* Evaluates if a drop on the given target is allowed.
*
* @param targetId the target id
*
* @return true if the resources may be dropped to the given target
*/
protected boolean mayDrop(CmsUUID targetId) {
boolean result = false;
try {
CmsObject cms = A_CmsUI.getCmsObject();
CmsResource target = cms.readResource(targetId);
result = cms.hasPermissions(target, CmsPermissionSet.ACCESS_WRITE, false, CmsResourceFilter.ALL);
} catch (Exception e) {
LOG.debug("Checking folder write permissions failed", e);
}
return result;
}
/**
* Returns the dialog context to use.
*
* @param dragEvent the drag event
*
* @return the dialog context
*
* @throws CmsException if reading the drag resource fails
*/
CmsExplorerDialogContext getContext(DragAndDropEvent dragEvent) throws CmsException {
List resources;
if ((dragEvent.getTransferable().getSourceComponent() instanceof Table)
&& !m_fileTable.getSelectedResources().isEmpty()) {
resources = m_fileTable.getSelectedResources();
} else {
CmsObject cms = A_CmsUI.getCmsObject();
CmsUUID sourceId = (CmsUUID)dragEvent.getTransferable().getData("itemId");
CmsResource source = cms.readResource(sourceId);
resources = Collections.singletonList(source);
}
CmsExplorerDialogContext context = new CmsExplorerDialogContext(
m_appContext,
CmsFileExplorer.this,
resources);
return context;
}
}
/**
* Context menu builder for explorer.
*/
protected class MenuBuilder implements I_CmsContextMenuBuilder {
/** Tree builder used to build the tree of menu items. */
private CmsContextMenuTreeBuilder m_treeBuilder;
/**
* @see org.opencms.ui.I_CmsContextMenuBuilder#buildContextMenu(java.util.List, org.opencms.ui.components.contextmenu.CmsContextMenu)
*/
public void buildContextMenu(List resources, CmsContextMenu menu) {
CmsContextMenuTreeBuilder treeBuilder = new CmsContextMenuTreeBuilder(createDialogContext());
m_treeBuilder = treeBuilder;
CmsTreeNode tree = treeBuilder.buildAll(
OpenCms.getWorkplaceAppManager().getMenuItemProvider().getMenuItems());
for (CmsTreeNode node : tree.getChildren()) {
createItem(menu, node);
}
}
/**
* Gets the localized title for the context menu item by resolving any message key macros in the raw title using the current locale.
*
* @param item the unlocalized title
* @return the localized title
*/
String getTitle(I_CmsContextMenuItem item) {
return CmsVaadinUtils.localizeString(item.getTitle(A_CmsUI.get().getLocale()));
}
/**
* Creates a context menu item.
*
* @param parent the parent (either the context menu itself, or a parent item)
* @param node the node which should be added as a context menu item
*
* @return the created item
*/
private ContextMenuItem createItem(Object parent, CmsTreeNode node) {
final I_CmsContextMenuItem data = node.getData();
ContextMenuItem guiMenuItem = null;
if (parent instanceof CmsContextMenu) {
guiMenuItem = ((CmsContextMenu)parent).addItem(getTitle(data));
} else {
guiMenuItem = ((ContextMenuItem)parent).addItem(getTitle(data));
}
if (m_treeBuilder.getVisibility(data).isInActive()) {
guiMenuItem.setEnabled(false);
String key = m_treeBuilder.getVisibility(data).getMessageKey();
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(key)) {
guiMenuItem.setDescription(CmsVaadinUtils.getMessageText(key));
}
}
if (node.getChildren().size() > 0) {
for (CmsTreeNode childNode : node.getChildren()) {
createItem(guiMenuItem, childNode);
}
} else {
guiMenuItem.addItemClickListener(new ContextMenuItemClickListener() {
public void contextMenuItemClicked(ContextMenuItemClickEvent event) {
data.executeAction(createDialogContext());
}
});
}
return guiMenuItem;
}
}
/** Bean representing the file explorer navigation substate. */
static class StateBean {
/** Current folder. */
private String m_folder;
/** Project id. */
private String m_projectId;
/** The site root. */
private String m_siteRoot;
/**
* Creates a new state bean.
*
* @param siteRoot the site root
* @param folder the folder
* @param projectId the project id
*/
public StateBean(String siteRoot, String folder, String projectId) {
m_siteRoot = siteRoot;
m_folder = folder;
m_projectId = projectId;
if ("".equals(m_siteRoot)) {
m_siteRoot = "/";
}
}
/**
* Parses the state bean from a string.
*
* @param state the state string
* @return the state bean
*/
public static StateBean parse(String state) {
List fields = CmsStringUtil.splitAsList(state, "!!");
if (fields.size() >= 3) {
String projectId = fields.get(0);
String siteRoot = fields.get(1);
String folder = fields.get(2);
return new StateBean(siteRoot, folder, projectId);
} else {
return new StateBean(null, null, null);
}
}
/**
* Converts state bean to a string.
*
* @return the string format of the state
*/
public String asString() {
String result = m_projectId + "!!" + m_siteRoot + "!!" + m_folder + "!!";
return result;
}
/**
* Returns the folderId.
*
* @return the folderId
*/
public String getFolder() {
return m_folder;
}
/**
* Returns the projectId.
*
* @return the projectId
*/
public String getProjectId() {
return m_projectId;
}
/**
* Returns the siteRoot.
*
* @return the siteRoot
*/
public String getSiteRoot() {
return m_siteRoot;
}
}
/** The opened paths session attribute name. */
public static final String OPENED_PATHS = "explorer-opened-paths";
/** Site selector caption property. */
public static final String SITE_CAPTION = "site_caption";
/** Site selector site root property. */
public static final String SITE_ROOT = "site_root";
/** The state separator string. */
public static final String STATE_SEPARATOR = "!!";
/** Logger instance for this class. */
static final Log LOG = CmsLog.getLog(CmsFileExplorer.class);
/** The delete shortcut. */
private static final Action ACTION_DELETE = new ShortcutAction("Del", ShortcutAction.KeyCode.DELETE, null);
/** The open parent folder shortcut. */
private static final Action ACTION_FOLDER_UP = new ShortcutAction(
"Alt+ArrowUp",
ShortcutAction.KeyCode.ARROW_UP,
new int[] {ShortcutAction.ModifierKey.ALT});
/** The edit properties shortcut. */
private static final Action ACTION_PROPERTIES = new ShortcutAction(
"Alt+Enter",
ShortcutAction.KeyCode.ENTER,
new int[] {ShortcutAction.ModifierKey.ALT});
/** The rename shortcut. */
private static final Action ACTION_RENAME = new ShortcutAction("F2", ShortcutAction.KeyCode.F2, null);
/** The select all shortcut. */
private static final Action ACTION_SELECT_ALL = new ShortcutAction(
"Ctrl+A",
ShortcutAction.KeyCode.A,
new int[] {ShortcutAction.ModifierKey.CTRL});
/** The files and folder resource filter. */
private static final CmsResourceFilter FILES_N_FOLDERS = CmsResourceFilter.ONLY_VISIBLE;
/** The folders resource filter. */
private static final CmsResourceFilter FOLDERS = CmsResourceFilter.ONLY_VISIBLE_NO_DELETED.addRequireFolder();
/** The serial version id. */
private static final long serialVersionUID = 1L;
/** Threshold for updating the complete folder after file changes. */
private static final int UPDATE_FOLDER_THRESHOLD = 200;
/** The UI context. */
protected I_CmsAppUIContext m_appContext;
/** Saved explorer state used by dialogs after they have finished. */
protected String m_savedExplorerState = "";
/** The table containing the contents of the current folder. */
CmsFileTable m_fileTable;
/** The info path. */
TextField m_infoPath;
/** The explorer shortcuts. */
Map m_shortcutActions;
/** The bread crumb click listener. */
private ClickListener m_crumbListener;
/** The path bread crumb container. */
private CssLayout m_crumbs;
/** The currently viewed folder. */
private CmsUUID m_currentFolder;
/** The current app state. */
private String m_currentState;
/** The folder tree. */
private Tree m_fileTree;
/** The first visible file table item index. */
private int m_firstVisibleTableItemIndex;
/** The last context menu resources. */
private List m_lastDialogContextResources;
/** The new button. */
private Button m_newButton;
/** The opened paths by site. */
private Map m_openedPaths;
/** The publish button. */
private Button m_publishButton;
/** The search field. */
private TextField m_searchField;
/** The site selector. */
private ComboBox m_siteSelector;
/** The folder tree data container. */
private HierarchicalContainer m_treeContainer;
/** The upload drop area extension. */
private CmsUploadAreaExtension m_uploadArea;
/** The upload button. */
private CmsUploadButton m_uploadButton;
/**
* Constructor.
*/
@SuppressWarnings("unchecked")
public CmsFileExplorer() {
m_shortcutActions = new HashMap();
m_shortcutActions.put(ACTION_DELETE, new Runnable() {
public void run() {
if (!m_fileTable.getSelectedIds().isEmpty()) {
I_CmsDialogContext context1 = createDialogContext();
context1.start("Delete", new CmsDeleteDialog(context1));
}
}
});
m_shortcutActions.put(ACTION_FOLDER_UP, new Runnable() {
public void run() {
showParentFolder();
}
});
m_shortcutActions.put(ACTION_PROPERTIES, new Runnable() {
public void run() {
I_CmsWorkplaceAction propAction = new CmsPropertiesDialogAction();
I_CmsDialogContext context = createDialogContext();
if (propAction.getVisibility(A_CmsUI.getCmsObject(), context.getResources()).isActive()) {
propAction.executeAction(context);
}
}
});
m_shortcutActions.put(ACTION_RENAME, new Runnable() {
public void run() {
if ((m_fileTable.getSelectedIds().size() == 1)
&& isPropertyEditable(CmsResourceTableProperty.PROPERTY_RESOURCE_NAME)) {
CmsUUID id = m_fileTable.getSelectedIds().iterator().next();
editItemProperty(id, CmsResourceTableProperty.PROPERTY_RESOURCE_NAME);
}
}
});
m_shortcutActions.put(ACTION_SELECT_ALL, new Runnable() {
public void run() {
m_fileTable.selectAll();
}
});
m_fileTable = new CmsFileTable();
m_fileTable.setSizeFull();
m_fileTable.setMenuBuilder(new MenuBuilder());
m_fileTable.addItemClickListener(new ItemClickListener() {
private static final long serialVersionUID = 1L;
public void itemClick(ItemClickEvent event) {
handleFileItemClick(event);
}
});
m_uploadArea = new CmsUploadAreaExtension(m_fileTable);
m_uploadArea.addUploadListener(new I_UploadListener() {
public void onUploadFinished(List uploadedFiles) {
updateAll();
}
});
m_treeContainer = new HierarchicalContainer();
addTreeContainerProperties(
CmsResourceTableProperty.PROPERTY_RESOURCE_NAME,
CmsResourceTableProperty.PROPERTY_STATE,
CmsResourceTableProperty.PROPERTY_TYPE_ICON_RESOURCE,
CmsResourceTableProperty.PROPERTY_INSIDE_PROJECT,
CmsResourceTableProperty.PROPERTY_RELEASED_NOT_EXPIRED);
m_fileTree = new Tree();
m_fileTree.addStyleName(OpenCmsTheme.SIMPLE_DRAG);
m_fileTree.addStyleName(OpenCmsTheme.FULL_WIDTH_PADDING);
m_fileTree.setWidth("100%");
m_fileTree.setContainerDataSource(m_treeContainer);
m_fileTree.setItemIconPropertyId(CmsResourceTableProperty.PROPERTY_TYPE_ICON_RESOURCE);
m_fileTree.setItemCaptionPropertyId(CmsResourceTableProperty.PROPERTY_RESOURCE_NAME);
m_fileTree.addExpandListener(new ExpandListener() {
private static final long serialVersionUID = 1L;
public void nodeExpand(ExpandEvent event) {
selectTreeItem((CmsUUID)event.getItemId());
readTreeLevel((CmsUUID)event.getItemId());
}
});
m_fileTree.addCollapseListener(new CollapseListener() {
private static final long serialVersionUID = 1L;
public void nodeCollapse(CollapseEvent event) {
selectTreeItem((CmsUUID)event.getItemId());
}
});
m_fileTree.addCollapseListener(new CollapseListener() {
private static final long serialVersionUID = 1L;
public void nodeCollapse(CollapseEvent event) {
clearTreeLevel((CmsUUID)event.getItemId());
}
});
m_fileTree.addItemClickListener(new ItemClickListener() {
private static final long serialVersionUID = 1L;
public void itemClick(ItemClickEvent event) {
readFolder((CmsUUID)event.getItemId());
}
});
m_fileTree.setItemStyleGenerator(new ItemStyleGenerator() {
private static final long serialVersionUID = 1L;
public String getStyle(Tree source, Object itemId) {
return CmsFileTable.getStateStyle(source.getContainerDataSource().getItem(itemId));
}
});
m_fileTree.setNullSelectionAllowed(false);
// init drag and drop
ExplorerDropHandler handler = new ExplorerDropHandler();
m_fileTable.setDropHandler(handler);
m_fileTable.setDragMode(TableDragMode.MULTIROW);
m_fileTree.setDropHandler(handler);
m_fileTree.setDragMode(TreeDragMode.NONE);
m_siteSelector = createSiteSelect(A_CmsUI.getCmsObject());
m_infoPath = new TextField();
A_CmsFocusShortcutListener shortcutListener = new A_CmsFocusShortcutListener("Open path", KeyCode.ENTER, null) {
private static final long serialVersionUID = 1L;
@Override
public void blur(BlurEvent event) {
super.blur(event);
showCrumbs(true);
}
@Override
public void focus(FocusEvent event) {
super.focus(event);
showCrumbs(false);
}
@Override
public void handleAction(Object sender, Object target) {
openPath(m_infoPath.getValue());
}
};
shortcutListener.installOn(m_infoPath);
m_crumbs = new CssLayout();
m_crumbs.setPrimaryStyleName(OpenCmsTheme.CRUMBS);
m_crumbListener = new ClickListener() {
private static final long serialVersionUID = 1L;
public void buttonClick(ClickEvent event) {
openPath((String)event.getButton().getData());
}
};
m_searchField = new TextField();
m_searchField.setIcon(FontOpenCms.FILTER);
m_searchField.setInputPrompt(
Messages.get().getBundle(UI.getCurrent().getLocale()).key(Messages.GUI_EXPLORER_FILTER_0));
m_searchField.addStyleName(ValoTheme.TEXTFIELD_INLINE_ICON);
m_searchField.addTextChangeListener(new TextChangeListener() {
private static final long serialVersionUID = 1L;
public void textChange(TextChangeEvent event) {
filterTable(event.getText());
}
});
m_openedPaths = (Map)UI.getCurrent().getSession().getAttribute(OPENED_PATHS);
if (m_openedPaths == null) {
m_openedPaths = new HashMap();
// add the configured start folder for the start site
String startSite = CmsAppWorkplaceUi.get().getWorkplaceSettings().getUserSettings().getStartSite();
// remove trailing slashes
while (startSite.endsWith("/")) {
startSite = startSite.substring(0, startSite.length() - 1);
}
String startFolder = CmsAppWorkplaceUi.get().getWorkplaceSettings().getUserSettings().getStartFolder();
m_openedPaths.put(startSite, startFolder);
}
}
/**
* @see com.vaadin.navigator.ViewChangeListener#afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)
*/
public void afterViewChange(ViewChangeEvent event) {
m_fileTable.setFirstVisibleItemIndex(m_firstVisibleTableItemIndex);
}
/**
* @see com.vaadin.navigator.ViewChangeListener#beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)
*/
public boolean beforeViewChange(ViewChangeEvent event) {
m_firstVisibleTableItemIndex = m_fileTable.getFirstVisibleItemIndex();
OpenCms.getWorkplaceAppManager().storeAppSettings(
A_CmsUI.getCmsObject(),
CmsFileExplorerSettings.class,
m_fileTable.getTableSettings());
UI.getCurrent().getSession().setAttribute(OPENED_PATHS, m_openedPaths);
return true;
}
/**
* Changes to the given site and path.
*
* @param siteRoot the site root
* @param path the path inside the site
*/
public void changeSite(String siteRoot, String path) {
changeSite(siteRoot, path, false);
}
/**
* Switches to the requested site.
*
* @param siteRoot the site root
* @param path the folder path to open
* @param force force the path change, even if we are currently in the same site
*/
public void changeSite(String siteRoot, String path, boolean force) {
CmsObject cms = A_CmsUI.getCmsObject();
if (force || !cms.getRequestContext().getSiteRoot().equals(siteRoot)) {
CmsAppWorkplaceUi.get().changeSite(siteRoot);
populateFolderTree();
openPath(path);
m_siteSelector.select(siteRoot);
}
}
/**
* Gets all ids of resources in current folder.
*
* @return the
*/
public List getAllIds() {
return m_fileTable.getAllIds();
}
/**
* Returns the current folder id.
*
* @return the current folder structure id
*/
public CmsUUID getCurrentFolder() {
return m_currentFolder;
}
/**
* @see org.opencms.ui.apps.I_CmsHasShortcutActions#getShortcutActions()
*/
public Map getShortcutActions() {
return m_shortcutActions;
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceApp#initUI(org.opencms.ui.apps.I_CmsAppUIContext)
*/
public void initUI(I_CmsAppUIContext context) {
m_appContext = context;
m_appContext.setMenuDialogContext(new CmsExplorerDialogContext(m_appContext, this, null));
HorizontalSplitPanel sp = new HorizontalSplitPanel();
sp.setSizeFull();
sp.setFirstComponent(m_fileTree);
CmsFileExplorerSettings settings;
try {
settings = OpenCms.getWorkplaceAppManager().getAppSettings(
A_CmsUI.getCmsObject(),
CmsFileExplorerSettings.class);
m_fileTable.setTableState(settings);
} catch (Exception e) {
LOG.error("Error while reading file explorer settings from user.", e);
}
sp.setSecondComponent(m_fileTable);
int splitLeft = 399;
sp.setSplitPosition(splitLeft, Unit.PIXELS);
context.setAppContent(sp);
context.showInfoArea(true);
HorizontalLayout inf = new HorizontalLayout();
inf.setSizeFull();
inf.setSpacing(true);
inf.setMargin(true);
m_siteSelector.setWidth("379px");
inf.addComponent(m_siteSelector);
CssLayout crumbWrapper = new CssLayout();
crumbWrapper.setSizeFull();
crumbWrapper.setPrimaryStyleName(OpenCmsTheme.CRUMB_WRAPPER);
crumbWrapper.addComponent(m_crumbs);
m_infoPath.setWidth("100%");
crumbWrapper.addComponent(m_infoPath);
inf.addComponent(crumbWrapper);
inf.setExpandRatio(crumbWrapper, 1);
m_searchField.setWidth("200px");
inf.addComponent(m_searchField);
context.setAppInfo(inf);
initToolbarButtons(context);
populateFolderTree();
m_fileTable.updateColumnWidths(A_CmsUI.get().getPage().getBrowserWindowWidth() - splitLeft);
}
/**
* @see org.opencms.ui.apps.I_CmsCachableApp#isCachable()
*/
public boolean isCachable() {
return true;
}
/**
* @see org.opencms.ui.apps.I_CmsCachableApp#onRestoreFromCache()
*/
public void onRestoreFromCache() {
if (m_lastDialogContextResources != null) {
List updateIds = Lists.newArrayList();
for (CmsResource resource : m_lastDialogContextResources) {
updateIds.add(resource.getStructureId());
}
update(updateIds);
}
}
/**
* Call if site and or project have been changed.
*
* @param project the project
* @param siteRoot the site root
*/
public void onSiteOrProjectChange(CmsProject project, String siteRoot) {
if ((siteRoot != null) && !siteRoot.equals(getSiteRootFromState())) {
changeSite(siteRoot, m_openedPaths.get(siteRoot), true);
} else if ((project != null) && !project.getUuid().equals(getProjectIdFromState())) {
populateFolderTree();
openPath(getPathFromState());
}
m_appContext.updateOnChange();
setToolbarButtonsEnabled(!CmsAppWorkplaceUi.isOnlineProject());
}
/**
* @see org.opencms.ui.apps.I_CmsWorkplaceApp#onStateChange(java.lang.String)
*/
public void onStateChange(String state) {
state = normalizeState(state);
if ((m_currentState == null) || !m_currentState.equals(state)) {
m_currentState = state;
CmsObject cms = A_CmsUI.getCmsObject();
String siteRoot = getSiteRootFromState();
String path = getPathFromState();
CmsUUID projectId = getProjectIdFromState();
if ((projectId != null) && !cms.getRequestContext().getCurrentProject().getUuid().equals(projectId)) {
try {
CmsProject project = cms.readProject(projectId);
cms.getRequestContext().setCurrentProject(project);
CmsAppWorkplaceUi.get().getWorkplaceSettings().setProject(project.getUuid());
} catch (CmsException e) {
LOG.warn("Error reading project from history state", e);
}
changeSite(siteRoot, path, true);
} else if ((siteRoot != null) && !siteRoot.equals(cms.getRequestContext().getSiteRoot())) {
changeSite(siteRoot, path);
} else {
openPath(path);
}
}
}
/**
* @see org.opencms.ui.components.I_CmsWindowCloseListener#onWindowClose()
*/
public void onWindowClose() {
OpenCms.getWorkplaceAppManager().storeAppSettings(
A_CmsUI.getCmsObject(),
CmsFileExplorerSettings.class,
m_fileTable.getTableSettings());
UI.getCurrent().getSession().setAttribute(OPENED_PATHS, m_openedPaths);
}
/**
* Fills the file table with the resources from the given path.
*
* @param sitePath a folder site path
*/
public void populateFileTable(String sitePath) {
CmsObject cms = A_CmsUI.getCmsObject();
m_searchField.clear();
m_firstVisibleTableItemIndex = 0;
try {
List folderResources = cms.readResources(sitePath, FILES_N_FOLDERS, false);
m_fileTable.fillTable(cms, folderResources);
} catch (CmsException e) {
CmsErrorDialog.showErrorDialog(e);
LOG.error(e.getLocalizedMessage(), e);
}
}
/**
* Populates the folder tree.
*/
public void populateFolderTree() {
CmsObject cms = A_CmsUI.getCmsObject();
m_treeContainer.removeAllItems();
try {
CmsResource siteRoot = cms.readResource("/", FOLDERS);
addTreeItem(cms, siteRoot, null, m_treeContainer);
List folderResources = cms.readResources("/", FOLDERS, false);
for (CmsResource resource : folderResources) {
addTreeItem(cms, resource, siteRoot.getStructureId(), m_treeContainer);
}
m_fileTree.expandItem(siteRoot.getStructureId());
} catch (CmsException e) {
CmsErrorDialog.showErrorDialog(e);
LOG.error(e.getLocalizedMessage(), e);
}
}
/**
* Updates the table entries with the given ids.
*
* @param ids the ids of the table entries to update
*/
public void update(Collection ids) {
try {
CmsResource currentFolderRes = A_CmsUI.getCmsObject().readResource(m_currentFolder, CmsResourceFilter.ALL);
boolean updateFolder = m_fileTable.getItemCount() < UPDATE_FOLDER_THRESHOLD;
Set removeIds = new HashSet();
for (CmsUUID id : ids) {
boolean remove = false;
try {
CmsResource resource = A_CmsUI.getCmsObject().readResource(id, CmsResourceFilter.ALL);
remove = !CmsResource.getParentFolder(resource.getRootPath()).equals(
currentFolderRes.getRootPath());
} catch (CmsVfsResourceNotFoundException e) {
remove = true;
LOG.debug("Could not read update resource " + id, e);
}
if (remove) {
removeIds.add(id);
}
}
for (CmsUUID id : ids) {
if (!updateFolder) {
m_fileTable.update(id, removeIds.contains(id));
}
updateTree(id);
}
if (updateFolder) {
updateCurrentFolder(removeIds);
}
m_fileTable.updateSorting();
m_fileTable.clearSelection();
} catch (CmsException e) {
CmsErrorDialog.showErrorDialog(e);
}
}
/**
* Updates display for all contents of the current folder.
*/
public void updateAll() {
readFolder(m_currentFolder);
Set