edu.internet2.middleware.grouper.j2ee.GrouperUiRestServlet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of grouper-ui Show documentation
Show all versions of grouper-ui Show documentation
Internet2 Groups Management User Interface
/*******************************************************************************
* Copyright 2012 Internet2
*
* Licensed 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.
******************************************************************************/
/*
* @author mchyzer $Id: GrouperUiRestServlet.java,v 1.1 2009-10-11 22:04:17 mchyzer Exp $
*/
package edu.internet2.middleware.grouper.j2ee;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.exception.ExceptionUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import edu.internet2.middleware.grouper.cache.GrouperCacheUtils;
import edu.internet2.middleware.grouper.grouperUi.beans.RequestContainer;
import edu.internet2.middleware.grouper.grouperUi.beans.api.GuiSubject;
import edu.internet2.middleware.grouper.grouperUi.beans.json.AppState;
import edu.internet2.middleware.grouper.grouperUi.beans.json.GuiResponseJs;
import edu.internet2.middleware.grouper.grouperUi.beans.json.GuiScreenAction;
import edu.internet2.middleware.grouper.grouperUi.beans.json.GuiScreenAction.GuiMessageType;
import edu.internet2.middleware.grouper.grouperUi.beans.json.GuiSettings;
import edu.internet2.middleware.grouper.grouperUi.beans.ui.GrouperRequestContainer;
import edu.internet2.middleware.grouper.grouperUi.beans.ui.TextContainer;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.MiscMenu;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2Admin;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2AttributeDef;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2AttributeDefAttributeAssignment;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2AttributeDefName;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2Configure;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2Deprovisioning;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2ExternalEntities;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2Group;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2GroupAttributeAssignment;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2GroupImport;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2GroupPermission;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2GrouperLoader;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2GrouperReport;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2Main;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2MembershipAttributeAssignment;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2Public;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2Stem;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2StemAttributeAssignment;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2Subject;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2SubjectAttributeAssignment;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2SubjectPermission;
import edu.internet2.middleware.grouper.grouperUi.serviceLogic.UiV2SubjectResolution;
import edu.internet2.middleware.grouper.internal.util.GrouperUuid;
import edu.internet2.middleware.grouper.ui.GrouperUiFilter;
import edu.internet2.middleware.grouper.ui.GrouperUiFilter.UiSection;
import edu.internet2.middleware.grouper.ui.NoUserAuthenticatedException;
import edu.internet2.middleware.grouper.ui.exceptions.ControllerDone;
import edu.internet2.middleware.grouper.ui.exceptions.NoSessionException;
import edu.internet2.middleware.grouper.ui.util.GrouperUiConfig;
import edu.internet2.middleware.grouper.ui.util.GrouperUiUtils;
import edu.internet2.middleware.grouper.util.GrouperUtil;
import edu.internet2.middleware.subject.Subject;
import edu.internet2.middleware.subject.SubjectNotFoundException;
/**
* servlet for rest ui web services
*/
@SuppressWarnings("serial")
public class GrouperUiRestServlet extends HttpServlet {
/**
* response header for if this is a success or not T or F
*/
public static final String X_GROUPER_SUCCESS = "X-Grouper-success";
/**
* response header for the grouper response code
*/
public static final String X_GROUPER_RESULT_CODE = "X-Grouper-resultCode";
/**
* response header for the grouper response code
*/
public static final String X_GROUPER_RESULT_CODE2 = "X-Grouper-resultCode2";
/** logger */
private static final Log LOG = edu.internet2.middleware.grouper.util.GrouperUtil.getLog(GrouperUiRestServlet.class);
/** uris that it is ok to get (e.g. auto complete and other ajax components */
private static Set operationsOkGet = GrouperUtil.toSet(
MiscMenu.class.getSimpleName() + ".miscMenuStructure",
// ##############
// we need the Lite UI things in here in case someone installs it. We can remove at some point
"InviteExternalSubjects.groupToAssignFilter",
"SimpleMembershipUpdateFilter.filterUsers",
"SimpleMembershipUpdateFilter.filterGroups",
"SimpleMembershipUpdateMenu.advancedMenuStructure",
"SimpleMembershipUpdateImportExport.exportSubjectIdsCsv",
"SimpleMembershipUpdateImportExport.exportAllCsv",
"SimpleMembershipUpdateMenu.memberMenuStructure",
"SimpleMembershipUpdateFilter.filterMembers",
"SimpleAttributeUpdateFilter.filterAttributeDefs",
"SimpleAttributeUpdateFilter.filterCreatableNamespace",
"SimpleAttributeUpdateFilter.filterPrivilegeUsers",
"SimpleAttributeNameUpdateFilter.filterAttributeDefs",
"SimpleGroupUpdateFilter.filterGroups",
"SimpleAttributeNameUpdateFilter.filterAttributeDefNames",
"SimpleAttributeNameUpdateFilter.filterCreatableNamespace",
"SimpleGroupUpdateFilter.filterCreatableNamespace",
"SimpleGroupUpdateFilter.filterPrivilegeUsers",
"SimpleGroupUpdateFilter.filterRoles",
"SimpleAttributeUpdateFilter.filterAttributeDefsByOwnerType",
"SimpleAttributeUpdateFilter.filterAttributeNamesByOwnerType",
"SimpleAttributeUpdateFilter.filterGroups",
"SimpleAttributeUpdateFilter.filterGroupsForMembershipAssignment",
"SimpleAttributeUpdateFilter.filterStems",
"SimpleAttributeUpdateFilter.filterSubjects",
"SimpleAttributeUpdateMenu.assignmentMenuStructure",
"SimplePermissionUpdateFilter.filterPermissionAttributeDefs",
"SimplePermissionUpdateFilter.filterPermissionResources",
"SimplePermissionUpdateFilter.filterRoles",
"SimplePermissionUpdateFilter.filterSubjects",
"SimplePermissionUpdateFilter.filterActions",
"SimplePermissionUpdateMenu.assignmentMenuStructure",
"SimplePermissionUpdateFilter.filterLimitDefinitions",
"SimplePermissionUpdateFilter.filterLimitNames",
"SimplePermissionUpdateMenu.limitMenuStructure",
"SimpleGroupUpdateFilter.filterGroupsRolesEntities",
// #################
UiV2SubjectPermission.class.getSimpleName() + ".assignmentMenuStructure",
UiV2SubjectPermission.class.getSimpleName() + ".limitMenuStructure",
UiV2SubjectPermission.class.getSimpleName() + ".limitValueMenuStructure",
UiV2GroupPermission.class.getSimpleName() + ".assignmentMenuStructure",
UiV2GroupPermission.class.getSimpleName() + ".limitMenuStructure",
UiV2GroupPermission.class.getSimpleName() + ".limitValueMenuStructure",
UiV2Main.class.getSimpleName() + ".index",
UiV2Main.class.getSimpleName() + ".indexCustomUi",
UiV2Main.class.getSimpleName() + ".indexGshSimplifiedUi",
UiV2Main.class.getSimpleName() + ".folderMenu",
UiV2Main.class.getSimpleName() + ".folderMenuObjectPath",
UiV2Group.class.getSimpleName() + ".addMemberFilter",
UiV2Group.class.getSimpleName() + ".groupRoleAssignPermissionFilter",
UiV2GroupImport.class.getSimpleName() + ".groupExportSubmit",
UiV2Stem.class.getSimpleName() + ".stemCopyParentFolderFilter",
UiV2Stem.class.getSimpleName() + ".createGroupParentFolderFilter",
UiV2Stem.class.getSimpleName() + ".createStemParentFolderFilter",
UiV2StemAttributeAssignment.class.getSimpleName() + ".assignmentValueMenuStructure",
UiV2GroupAttributeAssignment.class.getSimpleName() + ".assignmentValueMenuStructure",
UiV2AttributeDefAttributeAssignment.class.getSimpleName() + ".assignmentValueMenuStructure",
UiV2SubjectAttributeAssignment.class.getSimpleName() + ".assignmentValueMenuStructure",
UiV2MembershipAttributeAssignment.class.getSimpleName() + ".assignmentValueMenuStructure",
UiV2AttributeDefName.class.getSimpleName() + ".assignmentValueMenuStructure",
UiV2AttributeDef.class.getSimpleName() + ".assignmentValueMenuStructure",
UiV2AttributeDef.class.getSimpleName() + ".attributeDefFilter",
UiV2AttributeDefName.class.getSimpleName() + ".attributeDefNameFilter",
UiV2GroupPermission.class.getSimpleName() + ".permissionActionNameFilter",
UiV2Subject.class.getSimpleName() + ".addToGroupFilter",
UiV2Group.class.getSimpleName() + ".groupUpdateFilter",
UiV2Group.class.getSimpleName() + ".groupReadFilter",
UiV2Group.class.getSimpleName() + ".groupCompositeFactorFilter",
UiV2Stem.class.getSimpleName() + ".addMemberFilter",
UiV2ExternalEntities.class.getSimpleName() + ".addGroupFilter",
UiV2Subject.class.getSimpleName() + ".addToStemFilter",
UiV2Subject.class.getSimpleName() + ".addToAttributeDefFilter",
UiV2Public.class.getSimpleName() + ".index",
UiV2Public.class.getSimpleName() + ".help",
UiV2AttributeDef.class.getSimpleName() + ".addMemberFilter",
UiV2Stem.class.getSimpleName() + ".createAttributeDefParentFolderFilter",
UiV2Admin.class.getSimpleName() + ".subjectApiDiagnosticsActAsCombo",
UiV2Deprovisioning.class.getSimpleName() + ".addMemberFilter",
UiV2GrouperReport.class.getSimpleName() + ".downloadReportForFolder",
UiV2GrouperReport.class.getSimpleName() + ".downloadReportForGroup",
UiV2SubjectResolution.class.getSimpleName() + ".addMemberFilter",
UiV2GrouperLoader.class.getSimpleName() + ".recentMembershipsGroupFromFilter",
UiV2Configure.class.getSimpleName() + ".configurationFileExport"
);
/**
* @see javax.servlet.http.HttpServlet#service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
*/
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
this.doGet(request, response);
}
/**
* @see javax.servlet.http.HttpServlet#service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
*/
@SuppressWarnings({ "unchecked" })
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
if (GrouperUiConfig.retrieveConfig().propertyValueBoolean("grouperUi.refreshCaches.onEveryRequest", false)) {
GrouperCacheUtils.clearAllCaches();
}
GrouperUiFilter.assignHttpServlet(this);
String uri = request.getRequestURI();
if (!uri.endsWith("/UiV2Main.index")
&& !uri.endsWith("/UiV2Public.index")) {
RequestContainer.retrieveFromRequest().setAjaxRequest(true);
}
//initialize the bean
GrouperRequestContainer.retrieveFromRequestOrCreate();
List urlStrings = extractUrlStrings(request);
GuiResponseJs guiResponseJs = GuiResponseJs.retrieveGuiResponseJs();
String appStateString = request.getParameter("appState");
AppState appState = GrouperUtil.jsonConvertFrom(appStateString, AppState.class );
//app state isnt there e.g. for ajax components
if (appState == null) {
appState = new AppState();
}
appState.initRequest();
try {
initGui();
} catch (NoUserAuthenticatedException nuae) {
//redirect to the error screen if no loginid could be found
response.sendRedirect(GrouperUiFilter.retrieveServletContext() + "/grouperExternal/public/UiV2Public.index?operation=UiV2Public.postIndex&function=UiV2Public.error&code=noUserAuthenticated");
return;
} catch (SubjectNotFoundException nuae) {
//redirect to the error screen if loginid did not resolve to a subject
response.sendRedirect(GrouperUiFilter.retrieveServletContext() + "/grouperExternal/public/UiV2Public.index?operation=UiV2Public.postIndex&function=UiV2Public.error&code=authenticatedSubjectNotFound");
return;
} catch (ControllerDone cd) {
guiResponseJs.printToScreen();
return;
}
boolean printToScreen = true;
//this is just the filename of the export, for the browser to save correctly if right click
if (GrouperUtil.length(urlStrings) == 3
&& StringUtils.equals("app", urlStrings.get(0))
&& (StringUtils.equals("SimpleMembershipUpdateImportExport.exportSubjectIdsCsv", urlStrings.get(1))
|| StringUtils.equals("SimpleMembershipUpdateImportExport.exportAllCsv", urlStrings.get(1)))) {
//strip off the filename
urlStrings = GrouperUtil.toList(urlStrings.get(0), urlStrings.get(1));
}
if (GrouperUtil.length(urlStrings) == 5
&& StringUtils.equals("app", urlStrings.get(0))
&& StringUtils.equals(UiV2GroupImport.class.getSimpleName() + ".groupExportSubmit", urlStrings.get(1))) {
//strip off the filename
urlStrings = GrouperUtil.toList(urlStrings.get(0), urlStrings.get(1));
}
/* todo isn't this already checked by the uiFilter? */
Subject loggedInSubject = GrouperUiFilter.retrieveSubjectLoggedIn(true, response);
if (loggedInSubject == null && !StringUtils.equals(UiV2Public.class.getSimpleName() + ".index", urlStrings.get(1))
&& !StringUtils.equals(UiV2Public.class.getSimpleName() + ".postIndex", urlStrings.get(1))
&& !StringUtils.defaultString(urlStrings.get(1)).startsWith("ExternalSubjectSelfRegister.")
&& !StringUtils.defaultString(urlStrings.get(1)).startsWith("UiV2ExternalSubjectSelfRegister.")) {
response.sendRedirect(GrouperUiFilter.retrieveServletContext() + "/grouperExternal/public/UiV2Public.index?operation=UiV2Public.postIndex&function=UiV2Public.error&code=anonymousSessionNotAllowed");
return;
}
//see what operation we are doing
if (GrouperUtil.length(urlStrings) == 2
&& (StringUtils.equals("public", urlStrings.get(0))
|| StringUtils.equals("app", urlStrings.get(0)))) {
String classAndMethodName = urlStrings.get(1);
//if there is a hash, then toss that part out
if (classAndMethodName.contains("#")) {
classAndMethodName = GrouperUtil.prefixOrSuffix(classAndMethodName, "#", true);
}
//lets do some simple validation, text dot text
if (!classAndMethodName.matches("^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$")) {
throw new RuntimeException("Invalid class and method name: '" + classAndMethodName + "'");
}
//I think we are all post all the time, right?
if (!StringUtils.equalsIgnoreCase("post", request.getMethod() )) {
if (!operationsOkGet.contains(classAndMethodName)) {
String errorMessage = "Cant process method: " + request.getMethod() + " for operation: " + classAndMethodName;
throw new RuntimeException(errorMessage);
}
}
String className = GrouperUtil.prefixOrSuffix(classAndMethodName, ".", true);
String methodName = GrouperUtil.prefixOrSuffix(classAndMethodName, ".", false);
//not very scientific, oh well
boolean uiv2 = className.toLowerCase().startsWith("uiv2");
//now lets call some simple reflection, must be public static void and take a request and response
className = "edu.internet2.middleware.grouper.grouperUi.serviceLogic." + className;
Object instance = null;
try {
instance = GrouperUtil.newInstance(GrouperUtil.forName(className));
} catch (RuntimeException re) {
GrouperUtil.injectInException(re, "Problem calling class and method: " + className + "." + methodName);
throw re;
}
try {
GrouperUtil.callMethod(instance.getClass(), instance, methodName,
new Class[]{HttpServletRequest.class, HttpServletResponse.class},
new Object[]{request, response}, true, false);
} catch (NoSessionException nse) {
if (uiv2) {
guiResponseJs.addAction(GuiScreenAction.newMessage(GuiMessageType.error,
TextContainer.retrieveFromRequest().getText().get("guiMiscNoSessionError")));
} else {
boolean addTextArea = guiResponseJs.isAddTextAreaTag();
//print out error message for user, a new one
guiResponseJs = new GuiResponseJs();
guiResponseJs.addAction(GuiScreenAction.newCloseModal());
guiResponseJs.setAddTextAreaTag(addTextArea);
UiSection uiSection = GrouperUiFilter.uiSectionForRequest();
String startOverKey = "simpleMembershipUpdate.startOver";
if (uiSection == UiSection.EXTERNAL) {
startOverKey = "externalSubjectSelfRegister.startOver";
}
guiResponseJs.addAction(GuiScreenAction.newAlert(GrouperUiUtils.message(startOverKey)));
}
} catch (ControllerDone cd) {
printToScreen = cd.isPrintGuiReponseJs();
//do nothing, this is ok
} catch (RuntimeException re) {
String error = "Problem calling reflection from URL: " + className + "." + methodName + "\n\n" + ExceptionUtils.getFullStackTrace(re);
if (uiv2 && GrouperUiUtils.vetoHandle(guiResponseJs, re)) {
LOG.debug(error);
} else {
LOG.error(error);
GrouperUiUtils.appendErrorToRequest(error);
if (uiv2) {
guiResponseJs.addAction(GuiScreenAction.newMessage(GuiMessageType.error,
TextContainer.retrieveFromRequest().getText().get("guiMiscErrorPrefix")
+ " " + GrouperUiUtils.escapeHtml(re.getMessage(), true)));
} else {
//if adding text area for form file submits, make sure to do that in errors too
boolean addTextArea = guiResponseJs.isAddTextAreaTag();
//print out error message for user, a new one
guiResponseJs = new GuiResponseJs();
guiResponseJs.addAction(GuiScreenAction.newCloseModal());
guiResponseJs.setAddTextAreaTag(addTextArea);
guiResponseJs.addAction(GuiScreenAction.newAlert("Error: " + GrouperUiUtils.escapeHtml(re.getMessage(), true)));
}
}
}
} else {
//print out error message for user, a new one
guiResponseJs = new GuiResponseJs();
String error = "Cant find logic for URL: "
+ GrouperUtil.toStringForLog(urlStrings);
guiResponseJs.addAction(GuiScreenAction.newAlert("Error: " + error));
LOG.error(error);
GrouperUiUtils.appendErrorToRequest(error);
}
if (printToScreen) {
guiResponseJs.printToScreen();
}
}
/**
* init stuff on gui
*/
public static void initGui() {
GuiSettings guiSettings = new GuiSettings();
guiSettings.storeToRequest();
guiSettings.setAuthnKey(GrouperUuid.getUuid());
// lets see where the templates are: assume grouperUiText.properties is in WEB-INF/classes,
// and templates are WEB-INF/templates
AppState appState = AppState.retrieveFromRequest();
if (!appState.isInitted()) {
GuiResponseJs guiResponseJs = GuiResponseJs.retrieveGuiResponseJs();
guiResponseJs.addAction(GuiScreenAction.newAssign("allObjects.guiSettings", guiSettings));
guiResponseJs.addAction(GuiScreenAction.newAssign("allObjects.appState.initted", true));
}
Subject loggedInSubject = null;
loggedInSubject = GrouperUiFilter.retrieveSubjectLoggedIn(true, null);
if (loggedInSubject != null) {
guiSettings.setLoggedInSubject(new GuiSubject(loggedInSubject));
}
}
/**
* for error messages, get a detailed report of the request
* @param request
* @return the string of descriptive result
*/
public static String requestDebugInfo(HttpServletRequest request) {
StringBuilder result = new StringBuilder();
result.append(" uri: ").append(request.getRequestURI());
result.append(", method: ").append(request.getMethod());
result.append(", decoded url strings: ");
List urlStrings = extractUrlStrings(request);
int urlStringsLength = GrouperUtil.length(urlStrings);
if (urlStringsLength == 0) {
result.append("[none]");
} else {
for (int i = 0; i < urlStringsLength; i++) {
result.append(i).append(": '").append(urlStrings.get(i)).append("'");
if (i != urlStringsLength - 1) {
result.append(", ");
}
}
}
return result.toString();
}
/**
* TODO change to GrouperRestServlet in next release
* take a request and get the list of url strings for the rest web service
* @see #extractUrlStrings(String)
* @param request is the request to get the url strings out of
* @return the list of url strings
*/
public static List extractUrlStrings(HttpServletRequest request) {
String requestResourceFull = request.getRequestURI();
return extractUrlStrings(requestResourceFull);
}
/**
* TODO change to GrouperRestServlet in next release
*
* take a request uri and break up the url strings not including the app name or servlet
* this does not include the url params (if applicable)
* if the input is: grouper-ws/servicesRest/xhtml/v1_3_000/groups/members
* then the result is a list of size 2: {"group", "members"}
*
*
* @param requestResourceFull
* @return the url strings
*/
private static List extractUrlStrings(String requestResourceFull) {
String[] requestResources = StringUtils.split(requestResourceFull, '/');
List urlStrings = new ArrayList();
//loop through and decode
int index = 0;
for (String requestResource : requestResources) {
//skip the app name and lite servlet
if (index++ < 2) {
continue;
}
//unescape the url encoding
urlStrings.add(GrouperUtil.escapeUrlDecode(requestResource));
}
return urlStrings;
}
}