es.eucm.mokap.backend.server.MokapBackend.java Source code

Introduction

Here is the source code for es.eucm.mokap.backend.server.MokapBackend.java

Source

/**
 *  Copyright [2014] [mokap.es]
 *
 *    This file is part of the mokap community backend (MCB).
 *    MCB is 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 es.eucm.mokap.backend.server;

import es.eucm.mokap.backend.controller.search.MokapSearchController;
import es.eucm.mokap.backend.controller.insert.MokapInsertController;
import es.eucm.mokap.backend.model.search.SearchParams;
import es.eucm.mokap.backend.model.search.SearchParamsFactory;
import es.eucm.mokap.backend.utils.ApiKeyVerifier;
import org.apache.commons.fileupload.FileItemIterator;
import org.apache.commons.fileupload.FileItemStream;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;

/**
 * Servlet class for the Repository main functions (insert, search...)
 */
public class MokapBackend extends HttpServlet {
    private static final long serialVersionUID = -1883047452996950111L;

    /**
     * Method: POST Processes post requests.
     * 
     * <pre>
     * - Requests must be multipart/form-data.
     * - The field with the file must be named "file". 
     * - The file must be a .zip compressed file with the structure
     *   defined in {@link UploadZipStructure}.
     * </pre>
     */
    public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        MokapInsertController iCont = new MokapInsertController();
        // Check api key
        if (!ApiKeyVerifier.checkApiKey(req, resp)) {
            return;
        } else {

            try {
                // Get the uploaded file stream
                FileItemStream fis = getUploadedFile(req);
                if (fis != null) {
                    // Actually process the uploaded resource
                    String str = iCont.processUploadedResource(fis);
                    // Send the response
                    PrintWriter out = resp.getWriter();
                    out.print(str);
                    out.flush();
                    out.close();
                } else {
                    resp.sendError(HttpServletResponse.SC_BAD_REQUEST,
                            ServerReturnMessages.INVALID_UPLOAD_FILENOTFOUND);
                }
            } catch (Exception e) {
                resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
                        ServerReturnMessages.m(ServerReturnMessages.GENERIC_INTERNAL_ERROR, e.getMessage()));
            }
        }
    }

    /**
     * Method: GET Processes get requests to perform a search. It performs an
     * index search with the keyword in that header. Requires a valid api key to
     * work.
     */
    @Override
    public void doGet(HttpServletRequest req, HttpServletResponse resp) {
        MokapSearchController sCont = new MokapSearchController();
        // Check api key
        try {
            if (!ApiKeyVerifier.checkApiKey(req, resp)) {
                PrintWriter out = resp.getWriter();
                out.print("Wrong API key.");
                out.flush();
                out.close();
            } else {
                PrintWriter out = resp.getWriter();

                // Get the parameters from the header / parameter
                SearchParams sp = SearchParamsFactory.create(req);
                String str = sCont.performSearch(sp);
                // Set the response encoding
                resp.setCharacterEncoding("UTF-8");
                resp.setContentType("application/json");
                out.print(str);
                out.flush();
                out.close();
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * Iterates the whole request in search for a file. When it finds it, it
     * creates a FileItemStream which contains it.
     * 
     * @param req
     *            The request to process
     * @return Returns THE FIRST file found in the upload request or null if no
     *         file could be found
     */
    private FileItemStream getUploadedFile(HttpServletRequest req) throws IOException, FileUploadException {
        // Create a new file upload handler
        ServletFileUpload upload = new ServletFileUpload();
        // Set the UTF-8 encoding to grab the correct uploaded filename,
        // especially for Chinese
        upload.setHeaderEncoding("UTF-8");

        FileItemStream file = null;

        /* Parse the request */
        FileItemIterator iter = upload.getItemIterator(req);
        while (iter.hasNext()) {
            FileItemStream item = iter.next();
            if (!item.isFormField()) {
                file = item;
                break;
            }
        }
        return file;
    }

}