org.opendatakit.aggregate.servlet.FormXmlServlet.java Source code

Introduction

Here is the source code for org.opendatakit.aggregate.servlet.FormXmlServlet.java

Source

/*
 * Copyright (C) 2009 Google Inc.
 * Copyright (C) 2010 University of Washington.
 *
 * 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.
 */

package org.opendatakit.aggregate.servlet;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.lang3.StringEscapeUtils;
import org.opendatakit.aggregate.ContextFactory;
import org.opendatakit.aggregate.constants.HtmlUtil;
import org.opendatakit.aggregate.constants.ServletConsts;
import org.opendatakit.aggregate.exception.ODKFormNotFoundException;
import org.opendatakit.aggregate.form.FormFactory;
import org.opendatakit.aggregate.form.IForm;
import org.opendatakit.common.persistence.exception.ODKDatastoreException;
import org.opendatakit.common.persistence.exception.ODKOverQuotaException;
import org.opendatakit.common.web.CallingContext;
import org.opendatakit.common.web.constants.BasicConsts;
import org.opendatakit.common.web.constants.HtmlConsts;

/**
 * Servlet to generate the XML file in plain text
 *
 * @author wbrunette@gmail.com
 * @author mitchellsundt@gmail.com
 *
 */
public class FormXmlServlet extends ServletUtilBase {

    /**
     * Serial number for serialization
     */
    private static final long serialVersionUID = -5861240658170389989L;

    /**
     * URI from base
     */
    public static final String ADDR = "formXml";
    public static final String WWW_ADDR = "www/formXml";

    /**
     * Title for generated webpage
     */
    private static final String TITLE_INFO = "Form Xml Viewer";

    /**
     * Handler for HTTP Get request that responds with the XML in plain
     *
     * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest,
     *      javax.servlet.http.HttpServletResponse)
     */
    @Override
    public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {

        // get parameters
        String formId = getParameter(req, ServletConsts.FORM_ID);
        if (formId == null) {
            errorMissingKeyParam(resp);
            return;
        }

        String readable = getParameter(req, ServletConsts.HUMAN_READABLE);
        boolean humanReadable = false;
        if (readable != null) {
            humanReadable = Boolean.parseBoolean(readable);
        }

        CallingContext cc = ContextFactory.getCallingContext(this, req);

        IForm form;
        try {
            form = FormFactory.retrieveFormByFormId(formId, cc);
        } catch (ODKFormNotFoundException e) {
            e.printStackTrace();
            odkIdNotFoundError(resp);
            return;
        } catch (ODKOverQuotaException e) {
            e.printStackTrace();
            quotaExceededError(resp);
            return;
        } catch (ODKDatastoreException e) {
            e.printStackTrace();
            datastoreError(resp);
            return;
        }
        String xmlString = null;

        try {
            if (form != null) {
                xmlString = form.getFormXml(cc);
            } else {
                odkIdNotFoundError(resp);
                return;
            }

            // Debug: String debugDisplay = WebUtils.escapeUTF8String(xmlString);

            if (humanReadable) {
                Map<String, String> properties = new HashMap<String, String>();
                properties.put(ServletConsts.FORM_ID, formId);
                String downloadXmlButton = HtmlUtil.createHtmlButtonToGetServlet(cc.getWebApplicationURL(ADDR),
                        ServletConsts.DOWNLOAD_XML_BUTTON_TXT, properties);

                beginBasicHtmlResponse(TITLE_INFO, resp, cc); // header info
                PrintWriter out = resp.getWriter();
                out.println("<h3>Form Name: <FONT COLOR=0000FF>" + form.getViewableName() + "</FONT></h3>");
                if (form.getFormFilename(cc) != null) {
                    out.println("<h3>File Name: <FONT COLOR=0000FF>" + form.getFormFilename(cc) + "</FONT></h3>");
                }
                out.println(downloadXmlButton); // download button
                out.println("<PRE>");
                out.print(StringEscapeUtils.escapeHtml4(xmlString));// form xml
                out.println("</PRE>");
                finishBasicHtmlResponse(resp); // footer info
            } else {
                resp.setCharacterEncoding(HtmlConsts.UTF8_ENCODE);
                resp.setContentType(HtmlConsts.RESP_TYPE_XML);
                PrintWriter out = resp.getWriter();
                if (form.getFormFilename(cc) != null) {
                    resp.setHeader(HtmlConsts.CONTENT_DISPOSITION, HtmlConsts.ATTACHMENT_FILENAME_TXT
                            + form.getFormFilename(cc) + BasicConsts.QUOTE + BasicConsts.SEMI_COLON);
                } else {
                    resp.setHeader(HtmlConsts.CONTENT_DISPOSITION,
                            HtmlConsts.ATTACHMENT_FILENAME_TXT + form.getViewableFormNameSuitableAsFileName()
                                    + ".xml" + BasicConsts.QUOTE + BasicConsts.SEMI_COLON);
                }
                out.print(xmlString);
            }
        } catch (ODKOverQuotaException e) {
            e.printStackTrace();
            quotaExceededError(resp);
        } catch (ODKDatastoreException e) {
            e.printStackTrace();
            odkIdNotFoundError(resp);
        }
    }
}