Files
alfresco-community-repo/source/java/org/alfresco/web/bean/clipboard/ClipboardBean.java
Kevin Roast cb69c74d73 . Fixed several minor bugs where the various small icons for Space objects were not displayed:
- Clipboard, Recent Spaces, Shortcuts and Space Selector now all show correct Forum or small Space icons as appropriate for the node
 - this is now possible since the forums icons patch standardised the way in which all small icons named
. Externalised actions missing from forums.jsp, forum.jsp and topic.jsp
. Added Create Shortcut action to Forums, Forum and Topic details pages (why not!)
 - The user can now create shortcuts to a Forums space, a Forum or a Topic
. Prototype work for Paste-as-link (not visible yet)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2571 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2006-03-22 17:41:41 +00:00

325 lines
11 KiB
Java

/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.web.bean.clipboard;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.faces.context.FacesContext;
import javax.faces.event.ActionEvent;
import javax.transaction.UserTransaction;
import org.alfresco.model.ContentModel;
import org.alfresco.service.cmr.model.FileExistsException;
import org.alfresco.service.cmr.model.FileFolderService;
import org.alfresco.service.cmr.model.FileNotFoundException;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.InvalidNodeRefException;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.web.app.Application;
import org.alfresco.web.app.context.UIContextService;
import org.alfresco.web.bean.NavigationBean;
import org.alfresco.web.bean.repository.Node;
import org.alfresco.web.bean.repository.Repository;
import org.alfresco.web.ui.common.Utils;
import org.alfresco.web.ui.common.component.UIActionLink;
import org.alfresco.web.ui.repo.component.shelf.UIClipboardShelfItem;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* @author Kevin Roast
*/
public class ClipboardBean
{
// ------------------------------------------------------------------------------
// Bean property getters and setters
/**
* @param nodeService The NodeService to set.
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* @param fileFolderService The FileFolderService to set.
*/
public void setFileFolderService(FileFolderService fileFolderService)
{
this.fileFolderService = fileFolderService;
}
/**
* @param navigator The NavigationBean to set.
*/
public void setNavigator(NavigationBean navigator)
{
this.navigator = navigator;
}
/**
* @return Returns the clipboard items.
*/
public List<ClipboardItem> getItems()
{
return this.items;
}
/**
* @param items The clipboard items to set.
*/
public void setItems(List<ClipboardItem> items)
{
this.items = items;
}
// ------------------------------------------------------------------------------
// Navigation action event handlers
/**
* Action handler called to add a node to the clipboard for a Copy operation
*/
public void copyNode(ActionEvent event)
{
UIActionLink link = (UIActionLink)event.getComponent();
Map<String, String> params = link.getParameterMap();
String id = params.get("id");
if (id != null && id.length() != 0)
{
addClipboardNode(id, ClipboardStatus.COPY);
}
}
/**
* Action handler called to add a node to the clipboard for a Cut operation
*/
public void cutNode(ActionEvent event)
{
UIActionLink link = (UIActionLink)event.getComponent();
Map<String, String> params = link.getParameterMap();
String id = params.get("id");
if (id != null && id.length() != 0)
{
addClipboardNode(id, ClipboardStatus.CUT);
}
}
/**
* Action handler call from the browse screen to Paste All clipboard items into the current Space
*/
public void pasteAll(ActionEvent event)
{
performPasteItems(-1, UIClipboardShelfItem.ACTION_PASTE_ALL);
}
/**
* Action handler called to paste one or all items from the clipboard
*/
public void pasteItem(ActionEvent event)
{
UIClipboardShelfItem.ClipboardEvent clipEvent = (UIClipboardShelfItem.ClipboardEvent)event;
int index = clipEvent.Index;
if (index >= this.items.size())
{
throw new IllegalStateException("Clipboard attempting paste a non existent item index: " + index);
}
performPasteItems(index, clipEvent.Action);
}
/**
* Perform a paste for the specified clipboard item(s)
*
* @param index of clipboard item to paste or -1 for all
* @param action the clipboard action to perform (see UIClipboardShelfItem)
*/
private void performPasteItems(int index, int action)
{
UserTransaction tx = null;
try
{
tx = Repository.getUserTransaction(FacesContext.getCurrentInstance());
tx.begin();
if (index == -1)
{
// paste all
for (int i=0; i<this.items.size(); i++)
{
performClipboardOperation(this.items.get(i), action);
}
// remove the cut operation item from the clipboard
List<ClipboardItem> newItems = new ArrayList<ClipboardItem>(this.items.size());
for (int i=0; i<this.items.size(); i++)
{
ClipboardItem item = this.items.get(i);
if (item.Mode != ClipboardStatus.CUT)
{
newItems.add(item);
}
}
setItems(newItems);
// TODO: after a paste all - remove items from the clipboard...? or not. ask linton
}
else
{
// single paste operation
ClipboardItem item = this.items.get(index);
performClipboardOperation(item, action);
if (item.Mode == ClipboardStatus.CUT)
{
this.items.remove(index);
}
}
// commit the transaction
tx.commit();
// refresh UI on success
UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans();
}
catch (Throwable err)
{
// rollback the transaction
try { if (tx != null) {tx.rollback();} } catch (Exception tex) {}
Utils.addErrorMessage(Application.getMessage(
FacesContext.getCurrentInstance(), MSG_ERROR_PASTE) + err.getMessage(), err);
}
}
/**
* Perform the operation for the specified clipboard item
*
* @param item the ClipboardItem
* @param action the clipboard action to perform (see UIClipboardShelfItem)
*/
private void performClipboardOperation(ClipboardItem item, int action)
throws FileExistsException, FileNotFoundException
{
NodeRef destRef = new NodeRef(Repository.getStoreRef(), this.navigator.getCurrentNodeId());
// TODO: Should we use primary parent here?
// We are assuming that the item exists in only a single parent and that the source for
// the clipboard operation (e.g. the source folder) is specifically that parent node.
// This does not allow for more than one possible parent node - or for linked objects!
ChildAssociationRef assocRef = this.nodeService.getPrimaryParent(item.Node.getNodeRef());
if (item.Mode == ClipboardStatus.COPY)
{
if (action == UIClipboardShelfItem.ACTION_PASTE_LINK)
{
if (logger.isDebugEnabled())
logger.debug("Attempting to link node ID: " + item.Node.getId() + " into node ID: " + destRef.getId());
// copy as link was specifically requested by the user
this.nodeService.addChild(
destRef,
item.Node.getNodeRef(),
ContentModel.ASSOC_CONTAINS,
assocRef.getQName());
}
else
{
if (logger.isDebugEnabled())
logger.debug("Attempting to copy node ID: " + item.Node.getId() + " into node ID: " + destRef.getId());
// call the node ops service to initiate the copy
this.fileFolderService.copy(
item.Node.getNodeRef(),
destRef,
null); // TODO: could add "Copy of ..." here if copy fails
}
}
else
{
if (logger.isDebugEnabled())
logger.debug("Attempting to move node ID: " + item.Node.getId() + " into node ID: " + destRef.getId());
// move the node
this.fileFolderService.move(
item.Node.getNodeRef(),
destRef,
null); // TODO: could add "Copy of ..." here if move fails
}
}
/**
* Add a clipboard node for an operation to the clipboard
*
* @param id ID of the node for the operation
* @param mode ClipboardStatus for the operation
*/
private void addClipboardNode(String id, ClipboardStatus mode)
{
try
{
NodeRef ref = new NodeRef(Repository.getStoreRef(), id);
// check for duplicates first
ClipboardItem item = new ClipboardItem(new Node(ref), mode);
boolean foundDuplicate = false;
for (int i=0; i<items.size(); i++)
{
if (items.get(i).equals(item))
{
// found a duplicate replace with new instance as copy mode may have changed
items.set(i, item);
foundDuplicate = true;
break;
}
}
// if duplicate not found, then append to list
if (foundDuplicate == false)
{
items.add(item);
}
}
catch (InvalidNodeRefException refErr)
{
Utils.addErrorMessage(MessageFormat.format(Application.getMessage(
FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] {id}) );
}
}
// ------------------------------------------------------------------------------
// Private data
private static Log logger = LogFactory.getLog(ClipboardBean.class);
/** I18N messages */
private static final String MSG_ERROR_PASTE = "error_paste";
/** The NodeService to be used by the bean */
protected NodeService nodeService;
/** The FileFolderService to be used by the bean */
protected FileFolderService fileFolderService;
/** The NavigationBean reference */
protected NavigationBean navigator;
/** Current state of the clipboard items */
private List<ClipboardItem> items = new ArrayList<ClipboardItem>(4);
}