org.openmrs.web.attribute.handler.LongFreeTextFileUploadHandler.java Source code

Introduction

Here is the source code for org.openmrs.web.attribute.handler.LongFreeTextFileUploadHandler.java

Source

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.web.attribute.handler;

import java.io.IOException;
import java.io.OutputStream;

import javax.servlet.http.HttpServletRequest;

import org.openmrs.customdatatype.CustomDatatype;
import org.openmrs.customdatatype.DownloadableDatatypeHandler;
import org.openmrs.customdatatype.InvalidCustomValueException;
import org.openmrs.customdatatype.datatype.LongFreeTextDatatype;
import org.openmrs.web.WebUtil;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartRequest;

/**
 * Handler for the {@link LongFreeTextDatatype} that displays as a file upload input.
 * @since 1.9
 */
@Component
public class LongFreeTextFileUploadHandler
        implements WebDatatypeHandler<LongFreeTextDatatype, String>, DownloadableDatatypeHandler<String> {

    /**
     * @see org.openmrs.customdatatype.CustomDatatypeHandler#setHandlerConfiguration(java.lang.String)
     */
    @Override
    public void setHandlerConfiguration(String handlerConfig) {
        // no configuration options are supported
    }

    /**
     * @see org.openmrs.web.attribute.handler.HtmlDisplayableDatatypeHandler#toHtmlSummary(org.openmrs.customdatatype.CustomDatatype, java.lang.String)
     */
    @Override
    public CustomDatatype.Summary toHtmlSummary(CustomDatatype<String> datatype, String valueReference) {
        CustomDatatype.Summary summary = datatype.getTextSummary(valueReference);
        summary.setSummary(WebUtil.escapeHTML(summary.getSummary()));
        return summary;
    }

    /**
     * @see org.openmrs.web.attribute.handler.HtmlDisplayableDatatypeHandler#toHtml(org.openmrs.customdatatype.CustomDatatype, java.lang.String)
     */
    @Override
    public String toHtml(CustomDatatype<String> datatype, String valueReference) {
        return WebUtil.escapeHTML(datatype.fromReferenceString(valueReference));
    }

    /**
     * @see org.openmrs.web.attribute.handler.WebDatatypeHandler#getWidgetHtml(org.openmrs.customdatatype.CustomDatatype, java.lang.String, java.lang.String, java.lang.Object)
     */
    @Override
    public String getWidgetHtml(LongFreeTextDatatype datatype, String formFieldName, String widgetId,
            String startingValue) {
        StringBuilder sb = new StringBuilder();
        sb.append("<input type=\"file\" id=\"" + widgetId + "\" name=\"" + formFieldName + "\"/>\n");
        sb.append("<script>\n");
        sb.append("jQuery('#" + widgetId + "').closest('form')");
        sb.append("    .attr('method', 'post').attr('enctype', 'multipart/form-data');\n");
        sb.append("</script>");
        return sb.toString();
    }

    /**
     * @see org.openmrs.web.attribute.handler.WebDatatypeHandler#getValue(org.openmrs.customdatatype.CustomDatatype, javax.servlet.http.HttpServletRequest, java.lang.String)
     */
    @Override
    public String getValue(LongFreeTextDatatype datatype, HttpServletRequest request, String formFieldName)
            throws InvalidCustomValueException {
        if (request instanceof MultipartRequest) {
            MultipartFile file = ((MultipartRequest) request).getFile(formFieldName);
            try {
                return new String(file.getBytes());
            } catch (IOException e) {
                throw new InvalidCustomValueException("Error handling file upload as a String", e);
            }
        } else {
            throw new IllegalArgumentException(
                    "Programming error: file upload handler can only be used in a form with enctype='multipart/form-data'");
        }
    }

    /**
     * @see org.openmrs.customdatatype.DownloadableDatatypeHandler#getContentType(org.openmrs.customdatatype.CustomDatatype, java.lang.String)
     */
    @Override
    public String getContentType(CustomDatatype<String> dt, String valueReference) {
        return "text/plain; charset=utf-8";
    }

    /**
     * @see org.openmrs.customdatatype.DownloadableDatatypeHandler#getFilename(org.openmrs.customdatatype.CustomDatatype, java.lang.String)
     */
    @Override
    public String getFilename(CustomDatatype<String> dt, String valueReference) {
        return "OpenMRS-long-free-text.txt";
    }

    /**
     * @see org.openmrs.customdatatype.DownloadableDatatypeHandler#writeToStream(org.openmrs.customdatatype.CustomDatatype, java.lang.String, java.io.OutputStream)
     */
    @Override
    public void writeToStream(CustomDatatype<String> dt, String valueReference, OutputStream os)
            throws IOException {
        String val = dt.fromReferenceString(valueReference);
        os.write(val.getBytes("UTF-8"));
    }

}