org.opencadc.tap.tmp.TempStorageManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cadc-tap-tmp Show documentation
OpenCADC TAP-1.1 temporary on-disk upload storage library
There is a newer version: 1.2.1
/*
 ************************************************************************
 *******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
 **************  CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES  **************
 *
 *  (c) 2016.                            (c) 2016.
 *  Government of Canada                 Gouvernement du Canada
 *  National Research Council            Conseil national de recherches
 *  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
 *  All rights reserved                  Tous droits réservés
 *
 *  NRC disclaims any warranties,        Le CNRC dénie toute garantie
 *  expressed, implied, or               énoncée, implicite ou légale,
 *  statutory, of any kind with          de quelque nature que ce
 *  respect to the software,             soit, concernant le logiciel,
 *  including without limitation         y compris sans restriction
 *  any warranty of merchantability      toute garantie de valeur
 *  or fitness for a particular          marchande ou de pertinence
 *  purpose. NRC shall not be            pour un usage particulier.
 *  liable in any event for any          Le CNRC ne pourra en aucun cas
 *  damages, whether direct or           être tenu responsable de tout
 *  indirect, special or general,        dommage, direct ou indirect,
 *  consequential or incidental,         particulier ou général,
 *  arising from the use of the          accessoire ou fortuit, résultant
 *  software.  Neither the name          de l'utilisation du logiciel. Ni
 *  of the National Research             le nom du Conseil National de
 *  Council of Canada nor the            Recherches du Canada ni les noms
 *  names of its contributors may        de ses  participants ne peuvent
 *  be used to endorse or promote        être utilisés pour approuver ou
 *  products derived from this           promouvoir les produits dérivés
 *  software without specific prior      de ce logiciel sans autorisation
 *  written permission.                  préalable et particulière
 *                                       par écrit.
 *
 *  This file is part of the             Ce fichier fait partie du projet
 *  OpenCADC project.                    OpenCADC.
 *
 *  OpenCADC is free software:           OpenCADC est un logiciel libre ;
 *  you can redistribute it and/or       vous pouvez le redistribuer ou le
 *  modify it under the terms of         modifier suivant les termes de
 *  the GNU Affero General Public        la “GNU Affero General Public
 *  License as published by the          License” telle que publiée
 *  Free Software Foundation,            par la Free Software Foundation
 *  either version 3 of the              : soit la version 3 de cette
 *  License, or (at your option)         licence, soit (à votre gré)
 *  any later version.                   toute version ultérieure.
 *
 *  OpenCADC is distributed in the       OpenCADC est distribué
 *  hope that it will be useful,         dans l’espoir qu’il vous
 *  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
 *  without even the implied             GARANTIE : sans même la garantie
 *  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILITÉ
 *  or FITNESS FOR A PARTICULAR          ni d’ADÉQUATION À UN OBJECTIF
 *  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
 *  General Public License for           Générale Publique GNU Affero
 *  more details.                        pour plus de détails.
 *
 *  You should have received             Vous devriez avoir reçu une
 *  a copy of the GNU Affero             copie de la Licence Générale
 *  General Public License along         Publique GNU Affero avec
 *  with OpenCADC.  If not, see          OpenCADC ; si ce n’est
 *  .      pas le cas, consultez :
 *                                       .
 *
 *  $Revision: 6 $
 *
 ************************************************************************
 */

package org.opencadc.tap.tmp;

import ca.nrc.cadc.dali.tables.TableWriter;
import ca.nrc.cadc.util.MultiValuedProperties;
import ca.nrc.cadc.uws.Job;
import ca.nrc.cadc.uws.server.RandomStringGenerator;
import ca.nrc.cadc.uws.web.InlineContentException;
import ca.nrc.cadc.uws.web.UWSInlineContentHandler;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.sql.ResultSet;
import org.apache.log4j.Logger;


/**
 * Basic temporary storage implementation for a tap service.  This doubles as a ResultStore and an InlineContentHandler
 * so it's not unusual for this to be set in two different places.
 *
 * @author pdowler
 */
public class TempStorageManager implements StorageManager {

    private static final Logger log = Logger.getLogger(TempStorageManager.class);
    
    protected Job job;
    protected String contentType;
    protected String filename;

    private final File baseDir;
    private final String baseURL;

    public TempStorageManager() {
        MultiValuedProperties props = TempStorageInitAction.getConfig();
        this.baseURL = props.getFirstPropertyValue(TempStorageInitAction.BASE_URL_KEY);
        this.baseDir = new File(props.getFirstPropertyValue(TempStorageInitAction.BASE_DIR_KEY));
    }
    
    // constructed by DelegatingStorageManager
    TempStorageManager(MultiValuedProperties props) {
        this.baseURL = props.getFirstPropertyValue(TempStorageInitAction.BASE_URL_KEY);
        this.baseDir = new File(props.getFirstPropertyValue(TempStorageInitAction.BASE_DIR_KEY));
    }

    @Override
    public void check() throws Exception {
        // check baseDir
        if (baseDir.isDirectory() && baseDir.canRead() && baseDir.canWrite()) {
            return;
        }
        throw new IOException("cannot use baseDir: " + baseDir 
                + " -- reason: isDir=" + baseDir.isDirectory()
                + " readable=" + baseDir.canRead()
                + " writable=" + baseDir.canWrite());
    }

    
    // used by TempStorageGetAction
    public File getStoredFile(String filename) {
        return getDestFile(filename);
    }

    // cadc-tap-server ResultStore implementation
    @Override
    public URL put(ResultSet rs, TableWriter writer)
            throws IOException {
        return put(rs, writer, null);
    }

    @Override
    public URL put(ResultSet rs, TableWriter writer, Integer maxRows)
            throws IOException {
        Long num = null;
        if (maxRows != null) {
            num = Long.valueOf(maxRows);
        }

        // TODO: store content-type with file so that TempStorageAction
        // TODO: can set content-type header correctly
        File dest = getDestFile(filename);
        URL ret = getURL(filename);
        try (FileOutputStream ostream = new FileOutputStream(dest)) {
            writer.write(rs, ostream, num);
        }
        return ret;
    }

    @Override
    public URL put(Throwable t, TableWriter writer) throws IOException {
        // TODO: store content-type with file so that TempStorageAction
        // can set content-type header correctly
        File dest = getDestFile(filename);
        URL ret = getURL(filename);
        try (FileOutputStream ostream = new FileOutputStream(dest)) {
            writer.write(t, ostream);
        }
        return ret;
    }

    @Override
    public void setJob(Job job) {
        this.job = job;
    }

    @Override
    public void setContentType(String contentType) {
        this.contentType = contentType;
    }

    @Override
    public void setFilename(String filename) {
        this.filename = filename;
    }

    private File getDestFile(String filename) {
        return new File(baseDir, filename);
    }

    private URL getURL(String filename) {
        StringBuilder sb = new StringBuilder();
        sb.append(baseURL);

        if (!baseURL.endsWith("/")) {
            sb.append("/");
        }

        sb.append(filename);
        String s = sb.toString();
        try {
            return new URL(s);
        } catch (MalformedURLException ex) {
            throw new RuntimeException("failed to create URL from " + s, ex);
        }
    }

    // cadc-uws-server UWSInlineContentHandler implementation
    @Override
    public Content accept(String name, String contentType, InputStream inputStream)
            throws InlineContentException, IOException {
        // store the file in tmp storage
        log.debug("name: " + name);
        log.debug("Content-Type: " + contentType);
        if (inputStream == null) {
            throw new IOException("InputStream cannot be null");
        }

        String filename = name + "-" + getRandomString();

        File put = new File(baseDir + "/" + filename);

        log.debug("put: " + put);
        log.debug("contentType: " + contentType);

        // TODO: store content-type with file so that TempStorageAction
        // can set content-type header correctly
        FileOutputStream fos = new FileOutputStream(put);
        byte[] buf = new byte[16384];
        int num = inputStream.read(buf);
        while (num > 0) {
            fos.write(buf, 0, num);
            num = inputStream.read(buf);
        }
        fos.flush();
        fos.close();

        URL retURL = new URL(baseURL + "/" + filename);
        Content ret = new Content();
        ret.name = UWSInlineContentHandler.CONTENT_PARAM_REPLACE;
        ret.value = new UWSInlineContentHandler.ParameterReplacement("param:" + name, retURL.toExternalForm());
        return ret;
    }

    private static String getRandomString() {
        return new RandomStringGenerator(16).getID();
    }
}