UnlockManageComponent.java
/***************************************************************************
* Copyright (C) 2003-2009 eXo Platform SAS.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Affero General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see<http://www.gnu.org/licenses/>.
*
**************************************************************************/
package org.exoplatform.ecm.webui.component.explorer.rightclick.manager;
import org.exoplatform.ecm.webui.component.explorer.UIJCRExplorer;
import org.exoplatform.ecm.webui.component.explorer.UIWorkingArea;
import org.exoplatform.ecm.webui.component.explorer.control.filter.*;
import org.exoplatform.ecm.webui.component.explorer.control.listener.UIWorkingAreaActionListener;
import org.exoplatform.ecm.webui.utils.JCRExceptionManager;
import org.exoplatform.ecm.utils.lock.LockUtil;
import org.exoplatform.ecm.webui.utils.Utils;
import org.exoplatform.portal.config.UserACL;
import org.exoplatform.services.jcr.core.ManageableRepository;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;
import org.exoplatform.services.wcm.utils.WCMCoreUtils;
import org.exoplatform.web.application.ApplicationMessage;
import org.exoplatform.webui.config.annotation.ComponentConfig;
import org.exoplatform.webui.config.annotation.EventConfig;
import org.exoplatform.webui.core.UIApplication;
import org.exoplatform.webui.event.Event;
import org.exoplatform.webui.ext.filter.UIExtensionFilter;
import org.exoplatform.webui.ext.filter.UIExtensionFilters;
import org.exoplatform.webui.ext.manager.UIAbstractManager;
import org.exoplatform.webui.ext.manager.UIAbstractManagerComponent;
import javax.jcr.Node;
import javax.jcr.PathNotFoundException;
import javax.jcr.Session;
import javax.jcr.lock.LockException;
import javax.jcr.version.VersionException;
import java.util.Arrays;
import java.util.List;
import java.util.regex.Matcher;
/**
* Created by The eXo Platform SARL
* Author : Hoang Van Hung
* hunghvit@gmail.com
* Aug 6, 2009
*/
@ComponentConfig(
events = {
@EventConfig(listeners = UnlockManageComponent.UnlockActionListener.class)
}
)
public class UnlockManageComponent extends UIAbstractManagerComponent {
private static final List<UIExtensionFilter> FILTERS
= Arrays.asList(new UIExtensionFilter[]{new IsNotInTrashFilter(),
new IsHoldsLockFilter(),
new IsNotLockedFilter(true, true),
new CanSetPropertyFilter(),
new IsCheckedOutFilter(),
new IsNotTrashHomeNodeFilter() });
private static final Log LOG = ExoLogger.getLogger(UnlockManageComponent.class.getName());
@UIExtensionFilters
public List<UIExtensionFilter> getFilters() {
return FILTERS;
}
private static Node getNodeByPath(String nodePath, UIJCRExplorer uiExplorer) throws Exception {
Matcher matcher = UIWorkingArea.FILE_EXPLORER_URL_SYNTAX.matcher(nodePath);
String wsName = null;
if (matcher.find()) {
wsName = matcher.group(1);
nodePath = matcher.group(2);
} else {
throw new IllegalArgumentException("The ObjectId is invalid '"+ nodePath + "'");
}
Session session = uiExplorer.getSessionByWorkspace(wsName);
return uiExplorer.getNodeByPath(nodePath, session);
}
private static void processUnlock(String nodePath,
Event<UnlockManageComponent> event,
UIJCRExplorer uiExplorer) throws Exception {
UIApplication uiApp = uiExplorer.getAncestorOfType(UIApplication.class);
Node node;
Session session;
try {
// Use the method getNodeByPath because it is link aware
node = getNodeByPath(nodePath, uiExplorer);
// Reset the session to manage the links that potentially change of workspace
session = node.getSession();
} catch(PathNotFoundException path) {
uiApp.addMessage(new ApplicationMessage("UIPopupMenu.msg.path-not-found-exception",
null,ApplicationMessage.WARNING));
return;
} catch (Exception e) {
JCRExceptionManager.process(uiApp, e);
return;
}
String superUser = WCMCoreUtils.getService(UserACL.class).getSuperUser();
String remoteUser = WCMCoreUtils.getRemoteUser();
if (remoteUser.equalsIgnoreCase(superUser)) {
session = WCMCoreUtils.getSystemSessionProvider()
.getSession(node.getSession().getWorkspace().getName(),
(ManageableRepository) node.getSession().getRepository());
node = (Node)session.getItem(node.getPath());
}
try {
if(node.holdsLock()) {
String lockToken = LockUtil.getLockToken(node);
if(lockToken != null) {
session.addLockToken(lockToken);
}
node.unlock();
node.removeMixin(Utils.MIX_LOCKABLE);
node.getSession().save();
//remove lock from Cache
LockUtil.removeLock(node);
}
} catch(LockException le) {
uiApp.addMessage(new ApplicationMessage("UIPopupMenu.msg.can-not-unlock-node", null, ApplicationMessage.WARNING));
uiExplorer.updateAjax(event);
return;
} catch(VersionException versionException) {
Object[] args = {node.getName()};
uiApp.addMessage(new ApplicationMessage("UIPopupMenu.msg.can-not-unlock-node-is-checked-in",
args,
ApplicationMessage.WARNING));
uiExplorer.updateAjax(event);
return;
} catch (Exception e) {
if (LOG.isErrorEnabled()) {
LOG.error("an unexpected error occurs while unloking the node", e);
}
JCRExceptionManager.process(uiApp, e);
uiExplorer.updateAjax(event);
}
}
public static class UnlockActionListener extends UIWorkingAreaActionListener<UnlockManageComponent> {
private void unlockManage(Event<UnlockManageComponent> event, UIJCRExplorer uiExplorer) throws Exception {
String nodePath = event.getRequestContext().getRequestParameter(OBJECTID);
if(nodePath.indexOf(";") > -1) {
processMultiUnlock(nodePath.split(";"), event, uiExplorer);
} else {
processUnlock(nodePath, event, uiExplorer);
}
}
private void processMultiUnlock(String[] nodePaths,
Event<UnlockManageComponent> event,
UIJCRExplorer uiExplorer) throws Exception {
for (String nodePath : nodePaths) {
if (acceptForMultiNode(event, nodePath))
processUnlock(nodePath, event, uiExplorer);
}
uiExplorer.getSession().save();
uiExplorer.updateAjax(event);
}
public void processEvent(Event<UnlockManageComponent> event) throws Exception {
UIJCRExplorer uiExplorer = event.getSource().getAncestorOfType(UIJCRExplorer.class);
unlockManage(event, uiExplorer);
}
}
@Override
public Class<? extends UIAbstractManager> getUIAbstractManagerClass() {
return null;
}
}