/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.apache.jetspeed.layout.impl;
import java.io.ByteArrayInputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.jetspeed.JetspeedActions;
import org.apache.jetspeed.ajax.AJAXException;
import org.apache.jetspeed.ajax.AjaxAction;
import org.apache.jetspeed.ajax.AjaxBuilder;
import org.apache.jetspeed.layout.PortletActionSecurityBehavior;
import org.apache.jetspeed.om.common.SecurityConstraint;
import org.apache.jetspeed.om.page.PageSecurity;
import org.apache.jetspeed.om.page.SecurityConstraintsDef;
import org.apache.jetspeed.page.PageManager;
import org.apache.jetspeed.request.RequestContext;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
/**
* Security Permission action
*
* AJAX Parameters:
* action = constraints
* method = add-def | update-def | remove-def | add-global | remove-global
* name = name of constraint definition or global definition
* xml = the constraints payload, same format as PSML constraint defs
*
* @author <a href="mailto:taylor@apache.org">David Sean Taylor </a>
* @version $Id: $
*/
public class SecurityConstraintsAction
extends BasePortletAction
implements AjaxAction, AjaxBuilder, Constants
{
protected static final Logger log = LoggerFactory.getLogger(SecurityConstraintsAction.class);
public SecurityConstraintsAction(String template,
String errorTemplate,
PageManager pm,
PortletActionSecurityBehavior securityBehavior)
{
super(template, errorTemplate, pm, securityBehavior);
}
public SecurityConstraintsAction(String template,
String errorTemplate,
PageManager pm)
{
this(template, errorTemplate, pm, null);
}
public boolean run(RequestContext requestContext, Map resultMap)
throws AJAXException
{
System.out.println( "SecurityConstraintsAction run" );
boolean success = true;
String status = "success";
try
{
resultMap.put(ACTION, "constraints");
// Get the necessary parameters off of the request
String method = getActionParameter(requestContext, "method");
if (method == null)
{
throw new RuntimeException("Method not provided");
}
resultMap.put("method", method);
if (false == checkAccess(requestContext, JetspeedActions.EDIT))
{
success = false;
resultMap.put(REASON, "Insufficient access to administer portal permissions");
return success;
}
int count = 0;
if (method.equals("add-def") || method.equals("update-def"))
{
count = updateConstraintDefinition(requestContext, resultMap);
}
else if (method.equals("remove-def"))
{
count = removeConstraintDefinition(requestContext, resultMap);
}
else if (method.equals("add-global"))
{
count = addGlobal(requestContext, resultMap);
}
else if (method.equals("remove-global"))
{
count = removeGlobal(requestContext, resultMap);
}
else
{
success = false;
resultMap.put(REASON, "Unsupported portal constraints method: " + method);
return success;
}
resultMap.put("count", Integer.toString(count));
resultMap.put(STATUS, status);
}
catch (Exception e)
{
System.out.println( "SecurityConstraintsAction run failure caused by " + e.getClass().getName() + " " + e.getMessage() );
e.printStackTrace();
log.error("exception administering portal permissions", e);
resultMap.put(REASON, e.toString());
success = false;
}
System.out.println( "SecurityConstraintsAction complete " + resultMap.toString() );
return success;
}
protected int removeConstraintDefinition(RequestContext requestContext, Map resultMap)
throws AJAXException
{
String name = getActionParameter(requestContext, "name");
if (name == null)
throw new AJAXException("Missing 'name' parameter");
try
{
PageSecurity pageSecurity = pageManager.getPageSecurity();
SecurityConstraintsDef def = pageSecurity.getSecurityConstraintsDef(name);
if (def == null)
{
return 0;
}
List defs = pageSecurity.getSecurityConstraintsDefs();
defs.remove(def);
pageSecurity.setSecurityConstraintsDefs(defs);
pageManager.updatePageSecurity(pageSecurity);
}
catch (Exception e)
{
throw new AJAXException(e);
}
return 1;
}
protected int updateConstraintDefinition(RequestContext requestContext, Map resultMap)
throws AJAXException
{
System.out.println( "SecurityConstraintsAction updateConstraintDefinition started" );
int count = 0;
boolean added = false;
String xml = getActionParameter(requestContext, "xml");
if (xml == null)
throw new AJAXException("Missing 'xml' parameter");
try
{
DocumentBuilderFactory domFactory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = domFactory.newDocumentBuilder();
String charset = requestContext.getCharacterEncoding();
byte [] bytes = (charset != null ? xml.getBytes(charset) : xml.getBytes());
Document document = builder.parse(new ByteArrayInputStream(bytes));
Element root = document.getDocumentElement();
String name = root.getAttribute("name");
PageSecurity pageSecurity = pageManager.getPageSecurity();
SecurityConstraintsDef def = pageSecurity.getSecurityConstraintsDef(name);
int defsSize = 0;
if (def == null)
{
def = pageManager.newSecurityConstraintsDef();
def.setName(name);
added = true;
}
NodeList xmlConstraints = root.getElementsByTagName("security-constraint");
int xmlSize = xmlConstraints.getLength();
if (added == false)
{
defsSize = def.getSecurityConstraints().size();
}
int min = (xmlSize < defsSize) ? xmlSize : defsSize;
List constraints = def.getSecurityConstraints();
NodeList owners = root.getElementsByTagName("owner");
if (owners.getLength() == 1)
{
}
for (int ix = 0; ix < min; ix++)
{
Element xmlConstraint = (Element)xmlConstraints.item(ix);
SecurityConstraint constraint = (SecurityConstraint)constraints.get(ix);
updateConstraintValues(xmlConstraint, constraint);
count++;
}
if (xmlSize < defsSize)
{
// remove constraints
List deletes = new ArrayList(defsSize - xmlSize);
for (int ix = min; ix < defsSize; ix++)
{
deletes.add(constraints.get(ix));
}
for (int ix = 0; ix < deletes.size(); ix++)
{
constraints.remove(deletes.get(ix));
count++;
}
}
else if (xmlSize > defsSize)
{
// add new constraints
for (int ix = min; ix < xmlSize; ix++)
{
Element xmlConstraint = (Element)xmlConstraints.item(ix);
SecurityConstraint constraint = pageManager.newPageSecuritySecurityConstraint();
updateConstraintValues(xmlConstraint, constraint);
constraints.add(constraint);
count++;
}
}
if (added)
{
pageSecurity.getSecurityConstraintsDefs().add(def);
pageSecurity.setSecurityConstraintsDefs(pageSecurity.getSecurityConstraintsDefs());
}
pageManager.updatePageSecurity(pageSecurity);
}
catch (Exception e)
{
System.out.println( "SecurityConstraintsAction updateConstraintDefinition failure caused by " + e.getClass().getName() + " " + e.getMessage() );
e.printStackTrace();
log.error( "SecurityConstraintsAction updateConstraintDefinition failure caused by " + e.getClass().getName() + " " + e.getMessage(), e );
throw new AJAXException(e);
}
return count;
}
protected void updateConstraintValues(Element xmlConstraint, SecurityConstraint constraint)
{
constraint.setRoles(parseCSVList(getChildText(xmlConstraint, "roles")));
constraint.setGroups(parseCSVList(getChildText(xmlConstraint, "groups")));
constraint.setPermissions(parseCSVList(getChildText(xmlConstraint, "permissions")));
constraint.setUsers(parseCSVList(getChildText(xmlConstraint, "users")));
}
protected String getChildText(Element parent, String childName)
{
NodeList children = parent.getElementsByTagName(childName);
if (children.getLength() > 0)
{
return ((Element)children.item(0)).getTextContent();
}
return null;
}
protected List parseCSVList(String csv)
{
if (csv != null)
{
List csvList = new ArrayList(4);
if (csv.indexOf(',') != -1)
{
StringTokenizer csvTokens = new StringTokenizer(csv, ",");
while (csvTokens.hasMoreTokens())
{
csvList.add(csvTokens.nextToken().trim());
}
}
else
{
csvList.add(csv);
}
return csvList;
}
return null;
}
protected int removeGlobal(RequestContext requestContext, Map resultMap)
throws AJAXException
{
int count = 0;
String name = getActionParameter(requestContext, "name");
if (name == null)
throw new AJAXException("Missing 'name' parameter");
try
{
PageSecurity pageSecurity = pageManager.getPageSecurity();
List globals = pageSecurity.getGlobalSecurityConstraintsRefs();
if (!globals.contains(name))
{
return 0;
}
globals.remove(name);
pageSecurity.setGlobalSecurityConstraintsRefs(globals);
pageManager.updatePageSecurity(pageSecurity);
count++;
}
catch (Exception e)
{
throw new AJAXException(e);
}
return count;
}
protected int addGlobal(RequestContext requestContext, Map resultMap)
throws AJAXException
{
int count = 0;
String name = getActionParameter(requestContext, "name");
if (name == null)
throw new AJAXException("Missing 'name' parameter");
try
{
PageSecurity pageSecurity = pageManager.getPageSecurity();
List globals = pageSecurity.getGlobalSecurityConstraintsRefs();
if (pageSecurity.getSecurityConstraintsDef(name) == null)
{
throw new AJAXException("global name doesnt exist in definitions");
}
if (globals.contains(name))
{
// already exist;
return count;
}
globals.add(name);
pageSecurity.setGlobalSecurityConstraintsRefs(globals);
pageManager.updatePageSecurity(pageSecurity);
count++;
}
catch (Exception e)
{
throw new AJAXException(e);
}
return count;
}
}