/* Copyright 2007 You may not modify, use, reproduce, or distribute this software except in compliance with the terms of the License at:
 http://developer.sun.com/berkeley_license.html
 $Id: XmlHttpProxyServlet.java 3181 2008-12-03 13:19:19Z heiko.braun@jboss.com $
*/
package jmaki.xhp;

import org.json.JSONObject;

import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLEncoder;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.StringTokenizer;
import java.util.logging.Level;
import java.util.logging.Logger;

/**  XmlHttpProxyServlet
 *   @author Greg Murray
 */
public class XmlHttpProxyServlet extends HttpServlet
{

  public static String REMOTE_USER = "REMOTE_USER";

  private static String XHP_LAST_MODIFIED = "xhp_last_modified_key";
  private static String XHP_CONFIG = "xhp.json";

  private static boolean allowXDomain = false;
  private static boolean requireSession = false;
  private static boolean createSession = false;
  private static String defaultContentType = "application/json;charset=UTF-8";
  private static boolean rDebug = false;
  private Logger logger = null;
  private XmlHttpProxy xhp = null;
  private ServletContext ctx;
  private JSONObject services = null;
  private String resourcesDir = "/resources/";
  private String classpathResourcesDir = "/META-INF/resources/";
  private String headerToken = "jmaki-";
  private String testToken = "xtest-";

  private static String testUser;
  private static String testPass;

  private static String setCookie;
  
  public XmlHttpProxyServlet() {
    if (rDebug) {
      logger = getLogger();
    }
      
  }

  public void init(ServletConfig config) throws ServletException {
    super.init(config);
    ctx = config.getServletContext();
    // set the response content type
    if (ctx.getInitParameter("responseContentType") != null) {
      defaultContentType = ctx.getInitParameter("responseContentType");
    }
    // allow for resources dir over-ride at the xhp level otherwise allow
    // for the jmaki level resources
    if (ctx.getInitParameter("jmaki-xhp-resources") != null) {
      resourcesDir = ctx.getInitParameter("jmaki-xhp-resources");
    } else if (ctx.getInitParameter("jmaki-resources") != null) {
      resourcesDir = ctx.getInitParameter("jmaki-resources");
    }
    // allow for resources dir over-ride
    if (ctx.getInitParameter("jmaki-classpath-resources") != null) {
      classpathResourcesDir = ctx.getInitParameter("jmaki-classpath-resources");
    }
    String requireSessionString = ctx.getInitParameter("requireSession");
    if (requireSessionString == null) requireSessionString = ctx.getInitParameter("jmaki-requireSession");
    if (requireSessionString != null) {
      if ("false".equals(requireSessionString)) {
        requireSession = false;
        getLogger().severe("XmlHttpProxyServlet: intialization. Session requirement disabled.");
      } else if ("true".equals(requireSessionString)) {
        requireSession = true;
        getLogger().severe("XmlHttpProxyServlet: intialization. Session requirement enabled.");
      }
    }
    String xdomainString = ctx.getInitParameter("allowXDomain");
    if (xdomainString == null) xdomainString = ctx.getInitParameter("jmaki-allowXDomain");
    if (xdomainString != null) {
      if ("true".equals(xdomainString)) {
        allowXDomain = true;
        getLogger().severe("XmlHttpProxyServlet: intialization. xDomain access is enabled.");
      } else if ("false".equals(xdomainString)) {
        allowXDomain = false;
        getLogger().severe("XmlHttpProxyServlet: intialization. xDomain access is disabled.");
      }
    }
    String createSessionString = ctx.getInitParameter("jmaki-createSession");
    if (createSessionString != null) {
      if ("true".equals(createSessionString)) {
        createSession = true;
        getLogger().severe("XmlHttpProxyServlet: intialization. create session is enabled.");
      } else if ("false".equals(xdomainString)) {
        createSession = false;
        getLogger().severe("XmlHttpProxyServlet: intialization. create session is disabled.");
      }
    }
    // if there is a proxyHost and proxyPort specified create an HttpClient with the proxy
    String proxyHost = ctx.getInitParameter("proxyHost");
    String proxyPortString = ctx.getInitParameter("proxyPort");
    if (proxyHost != null && proxyPortString != null) {
      int proxyPort = 8080;
      try {
        proxyPort= new Integer(proxyPortString).intValue();
        xhp = new XmlHttpProxy(proxyHost, proxyPort);
      } catch (NumberFormatException nfe) {
        getLogger().severe("XmlHttpProxyServlet: intialization error. The proxyPort must be a number");
        throw new ServletException("XmlHttpProxyServlet: intialization error. The proxyPort must be a number");
      }
    } else {
      xhp = new XmlHttpProxy();
    }
  }

  private void getServices(HttpServletResponse res)
  {
    InputStream is = null;
    try
    {
      URL url = ctx.getResource(resourcesDir + XHP_CONFIG);
      // use classpath if not found locally.
      //if (url == null) url = XmlHttpProxyServlet.class.getResource(classpathResourcesDir + XHP_CONFIG);
      if (url == null) url = XmlHttpProxyServlet.class.getResource(XHP_CONFIG);  // same package
      is = url.openStream();
    }
    catch (Exception ex)
    {
      try
      {
        getLogger().severe("XmlHttpProxyServlet error loading xhp.json : " + ex);
        PrintWriter writer = res.getWriter();
        writer.write("XmlHttpProxyServlet Error: Error loading xhp.json. Make sure it is available in the /resources directory of your applicaton.");
        writer.flush();
      }
      catch (Exception iox) {}
    }
    services = xhp.loadServices(is);
  }

  public void doDelete(HttpServletRequest req, HttpServletResponse res) {
    doProcess(req,res, XmlHttpProxy.DELETE);
  }

  public void doGet(HttpServletRequest req, HttpServletResponse res) {
    doProcess(req,res, XmlHttpProxy.GET);
  }

  public void doPost(HttpServletRequest req, HttpServletResponse res) {
    doProcess(req,res, XmlHttpProxy.POST);
  }

  public void doPut(HttpServletRequest req, HttpServletResponse res) {
    doProcess(req,res, XmlHttpProxy.PUT);
  }

  public void doProcess(HttpServletRequest req, HttpServletResponse res, String method)
  {

    boolean isPost = XmlHttpProxy.POST.equals(method);
    StringBuffer bodyContent = null;
    OutputStream out = null;
    PrintWriter writer = null;
    String serviceKey = null;
    try {
      BufferedReader in = req.getReader();
      String line = null;
      while ((line = in.readLine()) != null) {
        if (bodyContent == null) bodyContent = new StringBuffer();
        bodyContent.append(line);
      }
    } catch (Exception e) {
    }

    try
    {
      HttpSession session = null;
      // it really does not make sense to use create session with require session as
      // the create session will always result in a session created and the requireSession
      // will always succeed. Leaving the logic for now.
      if (createSession) {
        session = req.getSession(true);
      }
      if (requireSession) {
        // check to see if there was a session created for this request
        // if not assume it was from another domain and blow up
        // Wrap this to prevent Portlet exeptions
        session = req.getSession(false);
        if (session == null) {
          res.setStatus(HttpServletResponse.SC_FORBIDDEN);
          return;
        }
      }
      serviceKey = req.getParameter("id");
      // only to preven regressions - Remove before 1.0
      if (serviceKey == null) serviceKey = req.getParameter("key");
      // check if the services have been loaded or if they need to be reloaded
      if (services == null || configUpdated()) {
        getServices(res);
      }
      String urlString = null;
      String xslURLString = null;
      String userName = null;
      String password = null;
      String format = "json";
      String callback = req.getParameter("callback");
      String urlParams = req.getParameter("urlparams");
      String countString = req.getParameter("count");
      boolean passthrough = false;
      // encode the url to prevent spaces from being passed along
      if (urlParams != null) {
        urlParams = urlParams.replace(' ', '+');
      }
      // get the headers to pass through
      Map headers = null;
      // Forward all request headers starting with the header token jmaki-
      // and chop off the jmaki-
      Enumeration hnum = req.getHeaderNames();

      // test hack

      while (hnum.hasMoreElements()) {
        String name = (String)hnum.nextElement();
        if (name.startsWith(headerToken))
        {
          if (headers == null) headers = new HashMap();

          String value = "";
          // handle multi-value headers
          Enumeration vnum = req.getHeaders(name);
          while (vnum.hasMoreElements()) {
            value += (String)vnum.nextElement();
            if (vnum.hasMoreElements()) value += ";";
          }
          String sname = name.substring(headerToken.length(), name.length());
          headers.put(sname,value);
        }
        else if(name.startsWith(testToken))
        {
          // hack test capabilities for authentication
          if("xtest-user".equals(name)) testUser = req.getHeader("xtest-user");
          if("xtest-pass".equals(name)) testPass = req.getHeader("xtest-pass");
        }
      }

      String contentType = null;
      try
      {
        String actualServiceKey = serviceKey != null ? serviceKey : "default";
        if (services.has(actualServiceKey))
        {

          JSONObject service = services.getJSONObject(actualServiceKey);
          String serviceURL = service.getString("url");
          if(null==serviceURL)
            throw new IllegalArgumentException("xhp.json: service url is mising");

          if (service.has("passthrough")) passthrough =
              Boolean.valueOf(service.getString("passthrough"));

          if(service.has("contentType")) contentType = service.getString("contentType");

          if(null==testUser)
          {
            System.out.println("Ignore service configuration credentials");
            if (service.has("username")) userName = service.getString("username");
            if (service.has("password")) password = service.getString("password");
          }
          else
          {
            userName = testUser;
            password = testPass;
          }
          
          String apikey = "";
          if (service.has("apikey")) apikey = service.getString("apikey");
          if (service.has("xslStyleSheet")) xslURLString = service.getString("xslStyleSheet");

          // default to the service default if no url parameters are specified
          if(!passthrough)
          {
            if (urlParams == null && service.has("defaultURLParams")) {
              urlParams = service.getString("defaultURLParams");
            }

            // build the URL
            if (urlParams != null && serviceURL.indexOf("?") == -1){
              serviceURL += "?";
            } else  if (urlParams != null) {
              serviceURL += "&";
            }

            urlString = serviceURL + apikey;
            if (urlParams != null) urlString += "&" + urlParams;
          }

          if(passthrough)
          {
            StringBuffer sb = new StringBuffer();
            sb.append(serviceURL);

            // override service url and url params
            String path = req.getRequestURI();
            path = path.substring(path.indexOf("xhp/")+3, path.length());

            StringTokenizer tok = new StringTokenizer(path, "/");
            while(tok.hasMoreTokens())
            {
              String token = tok.nextToken();
              if(token.indexOf(";")!=-1)
                sb.append("/").append(token);    // ;JSESSIONID=XYZ
              else
                sb.append("/").append(URLEncoder.encode(token));
            }

            sb.append("?").append(req.getQueryString());

            urlString = sb.toString();
          }
        }
        else
        {
          writer = res.getWriter();
          if (serviceKey == null) writer.write("XmlHttpProxyServlet Error: id parameter specifying serivce required.");
          else writer.write("XmlHttpProxyServlet Error : service for id '" + serviceKey + "' not  found.");
          writer.flush();
          return;
        }
      }
      catch (Exception ex)
      {
        getLogger().severe("XmlHttpProxyServlet Error loading service: " + ex);
        res.setStatus(500);
      }

      Map paramsMap = new HashMap();
      paramsMap.put("format", format);
      // do not allow for xdomain unless the context level setting is enabled.
      if (callback != null && allowXDomain) {
        paramsMap.put("callback", callback);
      }
      if (countString != null) {
        paramsMap.put("count", countString);
      }

      InputStream xslInputStream = null;

      if (urlString == null) {
        writer = res.getWriter();
        writer.write("XmlHttpProxyServlet parameters:  id[Required] urlparams[Optional] format[Optional] callback[Optional]");
        writer.flush();
        return;
      }
      // support for session properties and also authentication name
      if (urlString.indexOf("${") != -1) {
        urlString = processURL(urlString, req, res);
      }
      // default to JSON
      String actualContentType = contentType!=null ? contentType : defaultContentType;
      res.setContentType(actualContentType);

      out = res.getOutputStream();
      // get the stream for the xsl stylesheet
      if (xslURLString != null) {
        // check the web root for the resource
        URL xslURL = null;
        xslURL = ctx.getResource(resourcesDir + "xsl/"+ xslURLString);
        // if not in the web root check the classpath
        if (xslURL == null) {
          xslURL = XmlHttpProxyServlet.class.getResource(classpathResourcesDir + "xsl/" + xslURLString);
        }
        if (xslURL != null) {
          xslInputStream  = xslURL.openStream();
        } else {
          String message = "Could not locate the XSL stylesheet provided for service id " +  serviceKey + ". Please check the XMLHttpProxy configuration.";
          getLogger().severe(message);
          res.setStatus(500);
          try {
            out.write(message.getBytes());
            out.flush();
            return;
          } catch (java.io.IOException iox){
          }
        }
      }

      if (!isPost)
      {
        xhp.processRequest(urlString, out, xslInputStream, paramsMap, headers, method, userName, password);
      }
      else
      {
        final String content = bodyContent != null ? bodyContent.toString() : "";
        if (bodyContent == null)
          getLogger().info("XmlHttpProxyServlet attempting to post to url " + urlString + " with no body content");
        xhp.doPost(urlString, out, xslInputStream, paramsMap, headers, content, req.getContentType(), userName, password);
      }
    }
    catch (Exception iox)
    {
      iox.printStackTrace();
      getLogger().severe("XmlHttpProxyServlet: caught " + iox);
      res.setStatus(500);
      /*try {
         writer = res.getWriter();
         writer.write("XmlHttpProxyServlet error loading service for " + serviceKey + " . Please notify the administrator.");
         writer.flush();
      } catch (java.io.IOException ix) {
         ix.printStackTrace();
      }*/
      return;
    }
    finally
    {
      try
      {
        if (out != null) out.close();
        if (writer != null) writer.close();
      } catch (java.io.IOException iox){}
    }
  }

  /* Allow for a EL style replacements in the serviceURL
   *
   * The constant REMOTE_USER will replace the contents of ${REMOTE_USER}
   * with the return value of request.getRemoteUserver() if it is not null
   * otherwise the ${REMOTE_USER} is replaced with a blank.
   *
   * If you use ${session.somekey} the ${session.somekey} will be replaced with
   * the String value of the session varialble somekey or blank if the session key
   * does not exist.
   *
  */
  private String processURL(String url, HttpServletRequest req, HttpServletResponse res) {
    String serviceURL = url;
    int start = url.indexOf("${");
    int end = url.indexOf("}", start);
    if (end != -1) {
      String prop = url.substring(start + 2, end).trim();
      // no matter what we will remove the ${}
      // default to blank like the JSP EL
      String replace = "";
      if (REMOTE_USER.equals(prop)) {
        if (req.getRemoteUser() != null) replace = req.getRemoteUser();
      }
      if (prop.toLowerCase().startsWith("session.")) {
        String sessionKey = prop.substring("session.".length(), prop.length());
        if (req.getSession().getAttribute(sessionKey) != null) {
          // force to a string
          replace = req.getSession().getAttribute(sessionKey).toString();
        }
      }
      serviceURL = serviceURL.substring(0, start) +
          replace +
          serviceURL.substring(end + 1, serviceURL.length());
    }
    // call recursively to process more than one instance of a ${ in the serviceURL
    if (serviceURL.indexOf("${") != -1) serviceURL = processURL(serviceURL, req, res);
    return serviceURL;
  }

  /**
   * Check to see if the configuration file has been updated so that it may be reloaded.
   */
  private boolean configUpdated() {
    try {
      URL url = ctx.getResource(resourcesDir + XHP_CONFIG);
      URLConnection con;
      if (url == null) return false ;
      con = url.openConnection();
      long lastModified = con.getLastModified();
      long XHP_LAST_MODIFIEDModified = 0;
      if (ctx.getAttribute(XHP_LAST_MODIFIED) != null) {
        XHP_LAST_MODIFIEDModified = ((Long)ctx.getAttribute(XHP_LAST_MODIFIED)).longValue();
      } else {
        ctx.setAttribute(XHP_LAST_MODIFIED, new Long(lastModified));
        return false;
      }
      if (XHP_LAST_MODIFIEDModified < lastModified) {
        ctx.setAttribute(XHP_LAST_MODIFIED, new Long(lastModified));
        return true;
      }
    } catch (Exception ex) {
      getLogger().severe("XmlHttpProxyServlet error checking configuration: " + ex);
    }
    return false;
  }

  public Logger getLogger() {
    if (logger == null) {
      logger = Logger.getLogger("jmaki.services.xhp.Log");

      // TODO: the logger breaks the GWT tests, because it writes to stderr
      // we'll turn it off for now.
      System.out.println("WARN: XHP proxy logging is turned off");
      logger.setLevel(Level.OFF);
    }
    return logger;
  }

  private void logMessage(String message) {
    if (rDebug) {
      getLogger().info(message);
    }
  }
}