| /* |
| 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.ofbiz.webapp.event; |
| |
| import static org.apache.ofbiz.base.util.UtilGenerics.checkMap; |
| |
| import java.io.BufferedReader; |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.io.InputStreamReader; |
| import java.io.OutputStream; |
| import java.io.Writer; |
| import java.util.HashMap; |
| import java.util.Locale; |
| import java.util.Map; |
| |
| import javax.servlet.ServletContext; |
| import javax.servlet.http.HttpServletRequest; |
| import javax.servlet.http.HttpServletResponse; |
| |
| import org.apache.xmlrpc.XmlRpcException; |
| import org.apache.xmlrpc.XmlRpcHandler; |
| import org.apache.xmlrpc.XmlRpcRequest; |
| import org.apache.xmlrpc.common.ServerStreamConnection; |
| import org.apache.xmlrpc.common.XmlRpcHttpRequestConfig; |
| import org.apache.xmlrpc.common.XmlRpcHttpRequestConfigImpl; |
| import org.apache.xmlrpc.server.AbstractReflectiveHandlerMapping; |
| import org.apache.xmlrpc.server.XmlRpcHttpServer; |
| import org.apache.xmlrpc.server.XmlRpcHttpServerConfig; |
| import org.apache.xmlrpc.server.XmlRpcNoSuchHandlerException; |
| import org.apache.xmlrpc.util.HttpUtil; |
| import org.apache.ofbiz.base.util.Debug; |
| import org.apache.ofbiz.base.util.UtilValidate; |
| import org.apache.ofbiz.entity.Delegator; |
| import org.apache.ofbiz.entity.DelegatorFactory; |
| import org.apache.ofbiz.service.DispatchContext; |
| import org.apache.ofbiz.service.GenericServiceException; |
| import org.apache.ofbiz.service.LocalDispatcher; |
| import org.apache.ofbiz.service.ModelService; |
| import org.apache.ofbiz.service.ServiceContainer; |
| import org.apache.ofbiz.service.ServiceUtil; |
| import org.apache.ofbiz.webapp.control.ConfigXMLReader; |
| import org.apache.ofbiz.webapp.control.ConfigXMLReader.Event; |
| import org.apache.ofbiz.webapp.control.ConfigXMLReader.RequestMap; |
| |
| /** |
| * XmlRpcEventHandler |
| */ |
| public class XmlRpcEventHandler extends XmlRpcHttpServer implements EventHandler { |
| |
| public static final String module = XmlRpcEventHandler.class.getName(); |
| protected Delegator delegator; |
| protected LocalDispatcher dispatcher; |
| |
| private Boolean enabledForExtensions = null; |
| private Boolean enabledForExceptions = null; |
| |
| public void init(ServletContext context) throws EventHandlerException { |
| String delegatorName = context.getInitParameter("entityDelegatorName"); |
| this.delegator = DelegatorFactory.getDelegator(delegatorName); |
| this.dispatcher = ServiceContainer.getLocalDispatcher(delegator.getDelegatorName(), delegator); |
| this.setHandlerMapping(new ServiceRpcHandler()); |
| |
| String extensionsEnabledString = context.getInitParameter("xmlrpc.enabledForExtensions"); |
| if (UtilValidate.isNotEmpty(extensionsEnabledString)) { |
| enabledForExtensions = Boolean.valueOf(extensionsEnabledString); |
| } |
| String exceptionsEnabledString = context.getInitParameter("xmlrpc.enabledForExceptions"); |
| if (UtilValidate.isNotEmpty(exceptionsEnabledString)) { |
| enabledForExceptions = Boolean.valueOf(exceptionsEnabledString); |
| } |
| } |
| |
| /** |
| * @see org.apache.ofbiz.webapp.event.EventHandler#invoke(ConfigXMLReader.Event, ConfigXMLReader.RequestMap, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) |
| */ |
| public String invoke(Event event, RequestMap requestMap, HttpServletRequest request, HttpServletResponse response) throws EventHandlerException { |
| String report = request.getParameter("echo"); |
| if (report != null) { |
| BufferedReader reader = null; |
| StringBuilder buf = new StringBuilder(); |
| try { |
| // read the inputstream buffer |
| String line; |
| reader = new BufferedReader(new InputStreamReader(request.getInputStream())); |
| while ((line = reader.readLine()) != null) { |
| buf.append(line).append("\n"); |
| } |
| } catch (Exception e) { |
| throw new EventHandlerException(e.getMessage(), e); |
| } finally { |
| if (reader != null) { |
| try { |
| reader.close(); |
| } catch (IOException e) { |
| throw new EventHandlerException(e.getMessage(), e); |
| } |
| } |
| } |
| Debug.logInfo("Echo: " + buf.toString(), module); |
| |
| // echo back the request |
| try { |
| response.setContentType("text/xml"); |
| Writer out = response.getWriter(); |
| out.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>"); |
| out.write("<methodResponse>"); |
| out.write("<params><param>"); |
| out.write("<value><string><![CDATA["); |
| out.write(buf.toString()); |
| out.write("]]></string></value>"); |
| out.write("</param></params>"); |
| out.write("</methodResponse>"); |
| out.flush(); |
| } catch (Exception e) { |
| throw new EventHandlerException(e.getMessage(), e); |
| } |
| } else { |
| try { |
| this.execute(this.getXmlRpcConfig(request), new HttpStreamConnection(request, response)); |
| } catch (XmlRpcException e) { |
| Debug.logError(e, module); |
| throw new EventHandlerException(e.getMessage(), e); |
| } |
| } |
| |
| return null; |
| } |
| |
| @Override |
| protected void setResponseHeader(ServerStreamConnection con, String header, String value) { |
| ((HttpStreamConnection) con).getResponse().setHeader(header, value); |
| } |
| |
| protected XmlRpcHttpRequestConfig getXmlRpcConfig(HttpServletRequest req) { |
| XmlRpcHttpRequestConfigImpl result = new XmlRpcHttpRequestConfigImpl(); |
| XmlRpcHttpServerConfig serverConfig = (XmlRpcHttpServerConfig) getConfig(); |
| |
| result.setBasicEncoding(serverConfig.getBasicEncoding()); |
| result.setContentLengthOptional(serverConfig.isContentLengthOptional()); |
| result.setEnabledForExtensions(serverConfig.isEnabledForExtensions()); |
| result.setGzipCompressing(HttpUtil.isUsingGzipEncoding(req.getHeader("Content-Encoding"))); |
| result.setGzipRequesting(HttpUtil.isUsingGzipEncoding(req.getHeaders("Accept-Encoding"))); |
| result.setEncoding(req.getCharacterEncoding()); |
| //result.setEnabledForExceptions(serverConfig.isEnabledForExceptions()); |
| HttpUtil.parseAuthorization(result, req.getHeader("Authorization")); |
| |
| // context overrides |
| if (enabledForExtensions != null) { |
| result.setEnabledForExtensions(enabledForExtensions); |
| } |
| if (enabledForExceptions != null) { |
| result.setEnabledForExtensions(enabledForExceptions); |
| } |
| return result; |
| } |
| |
| class OfbizRpcAuthHandler implements AbstractReflectiveHandlerMapping.AuthenticationHandler { |
| |
| public boolean isAuthorized(XmlRpcRequest xmlRpcReq) throws XmlRpcException { |
| XmlRpcHttpRequestConfig config = (XmlRpcHttpRequestConfig) xmlRpcReq.getConfig(); |
| |
| ModelService model; |
| try { |
| model = dispatcher.getDispatchContext().getModelService(xmlRpcReq.getMethodName()); |
| } catch (GenericServiceException e) { |
| throw new XmlRpcException(e.getMessage(), e); |
| } |
| |
| if (model != null && model.auth) { |
| String username = config.getBasicUserName(); |
| String password = config.getBasicPassword(); |
| |
| // check the account |
| Map<String, Object> context = new HashMap<String, Object>(); |
| context.put("login.username", username); |
| context.put("login.password", password); |
| |
| Map<String, Object> resp; |
| try { |
| resp = dispatcher.runSync("userLogin", context); |
| } catch (GenericServiceException e) { |
| throw new XmlRpcException(e.getMessage(), e); |
| } |
| |
| if (ServiceUtil.isError(resp)) { |
| return false; |
| } |
| } |
| |
| return true; |
| } |
| } |
| |
| class ServiceRpcHandler extends AbstractReflectiveHandlerMapping implements XmlRpcHandler { |
| |
| public ServiceRpcHandler() { |
| this.setAuthenticationHandler(new OfbizRpcAuthHandler()); |
| } |
| |
| @Override |
| public XmlRpcHandler getHandler(String method) throws XmlRpcNoSuchHandlerException, XmlRpcException { |
| ModelService model = null; |
| try { |
| model = dispatcher.getDispatchContext().getModelService(method); |
| } catch (GenericServiceException e) { |
| Debug.logWarning(e, module); |
| } |
| if (model == null) { |
| throw new XmlRpcNoSuchHandlerException("No such service [" + method + "]"); |
| } |
| return this; |
| } |
| |
| public Object execute(XmlRpcRequest xmlRpcReq) throws XmlRpcException { |
| DispatchContext dctx = dispatcher.getDispatchContext(); |
| String serviceName = xmlRpcReq.getMethodName(); |
| ModelService model = null; |
| try { |
| model = dctx.getModelService(serviceName); |
| } catch (GenericServiceException e) { |
| throw new XmlRpcException(e.getMessage(), e); |
| } |
| |
| // check remote invocation security |
| if (model == null || !model.export) { |
| throw new XmlRpcException("Unknown method"); |
| } |
| |
| // prepare the context -- single parameter type struct (map) |
| Map<String, Object> context = this.getContext(xmlRpcReq, serviceName); |
| |
| // add in auth parameters |
| XmlRpcHttpRequestConfig config = (XmlRpcHttpRequestConfig) xmlRpcReq.getConfig(); |
| String username = config.getBasicUserName(); |
| String password = config.getBasicPassword(); |
| if (UtilValidate.isNotEmpty(username)) { |
| context.put("login.username", username); |
| context.put("login.password", password); |
| } |
| |
| // add the locale to the context |
| if (context.get("locale") == null) { |
| context.put("locale", Locale.getDefault()); |
| } |
| |
| // invoke the service |
| Map<String, Object> resp; |
| try { |
| resp = dispatcher.runSync(serviceName, context); |
| } catch (GenericServiceException e) { |
| throw new XmlRpcException(e.getMessage(), e); |
| } |
| if (ServiceUtil.isError(resp)) { |
| Debug.logError(ServiceUtil.getErrorMessage(resp), module); |
| throw new XmlRpcException(ServiceUtil.getErrorMessage(resp)); |
| } |
| |
| // return only definied parameters |
| return model.makeValid(resp, ModelService.OUT_PARAM, false, null); |
| } |
| |
| protected Map<String, Object> getContext(XmlRpcRequest xmlRpcReq, String serviceName) throws XmlRpcException { |
| ModelService model; |
| try { |
| model = dispatcher.getDispatchContext().getModelService(serviceName); |
| } catch (GenericServiceException e) { |
| throw new XmlRpcException(e.getMessage(), e); |
| } |
| |
| // context placeholder |
| Map<String, Object> context = new HashMap<String, Object>(); |
| |
| if (model != null) { |
| int parameterCount = xmlRpcReq.getParameterCount(); |
| |
| // more than one parameter; use list notation based on service def order |
| if (parameterCount > 1) { |
| int x = 0; |
| for (String name: model.getParameterNames("IN", true, true)) { |
| context.put(name, xmlRpcReq.getParameter(x)); |
| x++; |
| |
| if (x == parameterCount) { |
| break; |
| } |
| } |
| |
| // only one parameter; if its a map use it as the context; otherwise make sure the service takes one param |
| } else if (parameterCount == 1) { |
| Object param = xmlRpcReq.getParameter(0); |
| if (param instanceof Map<?, ?>) { |
| context = checkMap(param, String.class, Object.class); |
| } else { |
| if (model.getDefinedInCount() == 1) { |
| String paramName = model.getInParamNames().iterator().next(); |
| context.put(paramName, xmlRpcReq.getParameter(0)); |
| } else { |
| throw new XmlRpcException("More than one parameter defined on service; cannot call via RPC with parameter list"); |
| } |
| } |
| } |
| |
| // do map value conversions |
| context = model.makeValid(context, ModelService.IN_PARAM); |
| } |
| |
| return context; |
| } |
| } |
| |
| class HttpStreamConnection implements ServerStreamConnection { |
| |
| protected HttpServletRequest request; |
| protected HttpServletResponse response; |
| |
| protected HttpStreamConnection(HttpServletRequest req, HttpServletResponse res) { |
| this.request = req; |
| this.response = res; |
| } |
| |
| public HttpServletRequest getRequest() { |
| return request; |
| } |
| |
| public HttpServletResponse getResponse() { |
| return response; |
| } |
| |
| public InputStream newInputStream() throws IOException { |
| return request.getInputStream(); |
| } |
| |
| public OutputStream newOutputStream() throws IOException { |
| response.setContentType("text/xml"); |
| return response.getOutputStream(); |
| } |
| |
| public void close() throws IOException { |
| response.getOutputStream().close(); |
| } |
| } |
| } |