org.fao.geonet.services.thumbnail.Set.java Source code

Java tutorial

Introduction

Here is the source code for org.fao.geonet.services.thumbnail.Set.java

Source

//=============================================================================
//===   Copyright (C) 2001-2007 Food and Agriculture Organization of the
//===   United Nations (FAO-UN), United Nations World Food Programme (WFP)
//===   and United Nations Environment Programme (UNEP)
//===
//===   This program is free software; you can redistribute it and/or modify
//===   it under the terms of the GNU General Public License as published by
//===   the Free Software Foundation; either version 2 of the License, or (at
//===   your option) any later version.
//===
//===   This program is distributed in the hope that it will be useful, but
//===   WITHOUT ANY WARRANTY; without even the implied warranty of
//===   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
//===   General Public License for more details.
//===
//===   You should have received a copy of the GNU General Public License
//===   along with this program; if not, write to the Free Software
//===   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
//===
//===   Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2,
//===   Rome - Italy. email: geonetwork@osgeo.org
//==============================================================================

package org.fao.geonet.services.thumbnail;

import jeeves.resources.dbms.Dbms;
import jeeves.server.ServiceConfig;
import jeeves.server.context.ServiceContext;
import jeeves.utils.Util;
import lizard.tiff.Tiff;
import org.apache.commons.io.FileUtils;
import org.fao.geonet.GeonetContext;
import org.fao.geonet.constants.Geonet;
import org.fao.geonet.constants.Params;
import org.fao.geonet.exceptions.ConcurrentUpdateEx;
import org.fao.geonet.kernel.DataManager;
import org.fao.geonet.lib.Lib;
import org.fao.geonet.services.NotInReadOnlyModeService;
import org.jdom.Element;

import javax.imageio.ImageIO;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;

public class Set extends NotInReadOnlyModeService {
    //--------------------------------------------------------------------------
    //---
    //--- Init
    //---
    //--------------------------------------------------------------------------

    public void init(String appPath, ServiceConfig params) throws Exception {
    }

    //--------------------------------------------------------------------------
    //---
    //--- Service
    //---
    //--------------------------------------------------------------------------

    public Element serviceSpecificExec(Element params, ServiceContext context) throws Exception {
        String id = Util.getParam(params, Params.ID);
        String type = Util.getParam(params, Params.TYPE);
        String version = Util.getParam(params, Params.VERSION);
        String file = Util.getParam(params, Params.FNAME);
        String scalingDir = Util.getParam(params, Params.SCALING_DIR);
        boolean scaling = Util.getParam(params, Params.SCALING, false);
        int scalingFactor = Util.getParamAsInt(params, Params.SCALING_FACTOR);

        boolean createSmall = Util.getParam(params, Params.CREATE_SMALL, false);
        String smallScalingDir = Util.getParam(params, Params.SMALL_SCALING_DIR, "");
        int smallScalingFactor = Util.getParam(params, Params.SMALL_SCALING_FACTOR, 0);

        Lib.resource.checkEditPrivilege(context, id);

        //-----------------------------------------------------------------------
        //--- environment vars

        GeonetContext gc = (GeonetContext) context.getHandlerContext(Geonet.CONTEXT_NAME);

        DataManager dataMan = gc.getDataManager();

        Dbms dbms = (Dbms) context.getResourceManager().open(Geonet.Res.MAIN_DB);

        //--- check if the metadata has been modified from last time

        if (version != null && !dataMan.getVersion(id).equals(version))
            throw new ConcurrentUpdateEx(id);

        //-----------------------------------------------------------------------
        //--- create destination directory

        String dataDir = Lib.resource.getDir(context, Params.Access.PUBLIC, id);

        new File(dataDir).mkdirs();

        //-----------------------------------------------------------------------
        //--- create the small thumbnail, removing the old one

        if (createSmall) {
            String smallFile = getFileName(file, true);
            String inFile = context.getUploadDir() + file;
            String outFile = dataDir + smallFile;

            removeOldThumbnail(context, dbms, id, "small", false);
            createThumbnail(inFile, outFile, smallScalingFactor, smallScalingDir);
            dataMan.setThumbnail(context, dbms, id, true, smallFile, false);
        }

        //-----------------------------------------------------------------------
        //--- create the requested thumbnail, removing the old one

        removeOldThumbnail(context, dbms, id, type, false);

        if (scaling) {
            String newFile = getFileName(file, type.equals("small"));
            String inFile = context.getUploadDir() + file;
            String outFile = dataDir + newFile;

            createThumbnail(inFile, outFile, scalingFactor, scalingDir);

            if (!new File(inFile).delete())
                context.error("Error while deleting thumbnail : " + inFile);

            dataMan.setThumbnail(context, dbms, id, type.equals("small"), newFile, false);
        } else {
            //--- move uploaded file to destination directory

            File inFile = new File(context.getUploadDir(), file);
            File outFile = new File(dataDir, file);

            if (outFile.exists() && !outFile.delete()) {
                throw new Exception("Unable to overwrite existing file: " + outFile);
            }
            try {
                FileUtils.moveFile(inFile, outFile);
            } catch (Exception e) {
                inFile.delete();
                throw new Exception("Unable to move uploaded thumbnail to destination: " + outFile + ". Error: "
                        + e.getMessage());
            }

            dataMan.setThumbnail(context, dbms, id, type.equals("small"), file, false);
        }

        dataMan.indexInThreadPool(context, id, dbms);
        //-----------------------------------------------------------------------

        Element response = new Element("a");
        response.addContent(new Element("id").setText(id));
        response.addContent(new Element("version").setText(dataMan.getNewVersion(id)));

        return response;
    }

    /**
     * TODO javadoc.
     *
     * @param id
     * @param context
     */
    private String createDataDir(String id, ServiceContext context) {
        String dataDir = Lib.resource.getDir(context, Params.Access.PUBLIC, id);
        if (!new File(dataDir).mkdirs()) {
            context.error("Failed to make dir: " + dataDir);
        }
        return dataDir;
    }

    // FIXME : not elegant
    public Element execOnHarvest(Element params, ServiceContext context, Dbms dbms, DataManager dataMan)
            throws Exception {

        String id = Util.getParam(params, Params.ID);
        String dataDir = createDataDir(id, context);

        //-----------------------------------------------------------------------
        //--- create the small thumbnail, removing the old one
        boolean createSmall = Util.getParam(params, Params.CREATE_SMALL, false);
        String file = Util.getParam(params, Params.FNAME);
        String scalingDir = Util.getParam(params, Params.SCALING_DIR, "width");
        boolean scaling = Util.getParam(params, Params.SCALING, false);
        int scalingFactor = Util.getParam(params, Params.SCALING_FACTOR, 1);
        String type = Util.getParam(params, Params.TYPE);
        String version = Util.getParam(params, Params.VERSION);

        if (createSmall) {
            String smallFile = getFileName(file, true);
            String inFile = context.getUploadDir() + file;
            String outFile = dataDir + smallFile;
            String smallScalingDir = Util.getParam(params, Params.SMALL_SCALING_DIR, "");
            int smallScalingFactor = Util.getParam(params, Params.SMALL_SCALING_FACTOR, 0);
            // FIXME should be done before removeOldThumbnail(context, dbms, id, "small");
            createThumbnail(inFile, outFile, smallScalingFactor, smallScalingDir);
            dataMan.setThumbnail(context, dbms, id, true, smallFile, false);
        }

        //-----------------------------------------------------------------------
        //--- create the requested thumbnail, removing the old one
        removeOldThumbnail(context, dbms, id, type, false);
        saveThumbnail(scaling, file, type, dataDir, scalingDir, scalingFactor, dataMan, dbms, id, context);

        //-----------------------------------------------------------------------
        dataMan.indexInThreadPool(context, id, dbms);
        Element response = new Element("Response");
        response.addContent(new Element("id").setText(id));
        // NOT NEEDEDresponse.addContent(new Element("version").setText(dataMan.getNewVersion(id)));

        return response;
    }

    public void addHarvested(Element params, ServiceContext context, Dbms dbms, DataManager dataMan)
            throws Exception {
        String id = Util.getParam(params, Params.ID);
        String dataDir = createDataDir(id, context);
        String type = Util.getParam(params, Params.TYPE);
        String version = Util.getParam(params, Params.VERSION);
        String file = Util.getParam(params, Params.FNAME);
        String scalingDir = Util.getParam(params, Params.SCALING_DIR, "width");
        boolean scaling = Util.getParam(params, Params.SCALING, false);
        int scalingFactor = Util.getParam(params, Params.SCALING_FACTOR, 1);

        boolean createSmall = Util.getParam(params, Params.CREATE_SMALL, false);
        String smallScalingDir = Util.getParam(params, Params.SMALL_SCALING_DIR, "");
        int smallScalingFactor = Util.getParam(params, Params.SMALL_SCALING_FACTOR, 0);

        //-----------------------------------------------------------------------
        //--- create the small thumbnail, removing the old one

        if (createSmall) {
            String smallFile = getFileName(file, true);
            String inFile = context.getUploadDir() + file;
            String outFile = dataDir + smallFile;
            removeOldThumbnail(context, dbms, id, "small", false);
            createThumbnail(inFile, outFile, smallScalingFactor, smallScalingDir);
            dataMan.setThumbnail(context, dbms, id, true, smallFile, false);
        }

        //-----------------------------------------------------------------------
        //--- create the requested thumbnail

        removeOldThumbnail(context, dbms, id, type, false);
        saveThumbnail(scaling, file, type, dataDir, scalingDir, scalingFactor, dataMan, dbms, id, context);

        dataMan.indexInThreadPool(context, id, dbms);
    }

    public void removeHarvested(Element params, ServiceContext context, Dbms dbms) throws Exception {
        String id = Util.getParam(params, Params.ID);
        String type = Util.getParam(params, Params.TYPE);
        removeOldThumbnail(context, dbms, id, type, true);
    }

    //--------------------------------------------------------------------------
    //---
    //--- Private methods
    //---
    //--------------------------------------------------------------------------

    /**
     * TODO Javadoc.
     *
     * @param scaling
     * @param file
     * @param type
     * @param dataDir
     * @param scalingDir
     * @param scalingFactor
     * @param dataMan
     * @param dbms
     * @param id
     * @param context
     * @throws Exception
     */
    private void saveThumbnail(boolean scaling, String file, String type, String dataDir, String scalingDir,
            int scalingFactor, DataManager dataMan, Dbms dbms, String id, ServiceContext context) throws Exception {
        if (scaling) {
            String newFile = getFileName(file, type.equals("small"));
            String inFile = context.getUploadDir() + file;
            String outFile = dataDir + newFile;

            createThumbnail(inFile, outFile, scalingFactor, scalingDir);
            if (!new File(inFile).delete())
                context.error("Error while deleting thumbnail : " + inFile);
            dataMan.setThumbnail(context, dbms, id, type.equals("small"), newFile, false);
        } else {
            //--- move uploaded file to destination directory
            File inFile = new File(context.getUploadDir(), file);
            File outFile = new File(dataDir, file);

            try {
                FileUtils.moveFile(inFile, outFile);
            } catch (Exception e) {
                inFile.delete();
                throw new Exception("Unable to move uploaded thumbnail to destination: " + outFile + ". Error: "
                        + e.getMessage());
            }

            dataMan.setThumbnail(context, dbms, id, type.equals("small"), file, false);
        }
    }

    private void removeOldThumbnail(ServiceContext context, Dbms dbms, String id, String type,
            boolean indexAfterChange) throws Exception {
        GeonetContext gc = (GeonetContext) context.getHandlerContext(Geonet.CONTEXT_NAME);

        DataManager dataMan = gc.getDataManager();

        Element result = dataMan.getThumbnails(dbms, id, context);

        if (result == null)
            throw new IllegalArgumentException("Metadata not found --> " + id);

        result = result.getChild(type);

        //--- if there is no thumbnail, we return

        if (result == null)
            return;

        //-----------------------------------------------------------------------
        //--- remove thumbnail

        dataMan.unsetThumbnail(context, dbms, id, type.equals("small"), indexAfterChange);

        //--- remove file

        String file = Lib.resource.getDir(context, Params.Access.PUBLIC, id) + getFileName(result.getText());
        if (!new File(file).delete())
            context.error("Error while deleting thumbnail : " + file);
    }

    //--------------------------------------------------------------------------

    private void createThumbnail(String inFile, String outFile, int scalingFactor, String scalingDir)
            throws IOException {
        BufferedImage origImg = getImage(inFile);

        int imgWidth = origImg.getWidth();
        int imgHeight = origImg.getHeight();

        int width;
        int height;

        if (scalingDir.equals("width")) {
            width = scalingFactor;
            height = width * imgHeight / imgWidth;
        } else {
            height = scalingFactor;
            width = height * imgWidth / imgHeight;
        }

        Image thumb = origImg.getScaledInstance(width, height, BufferedImage.SCALE_SMOOTH);

        BufferedImage bimg = new BufferedImage(width, height, BufferedImage.TRANSLUCENT);

        Graphics2D g = bimg.createGraphics();
        g.drawImage(thumb, 0, 0, null);
        g.dispose();

        ImageIO.write(bimg, IMAGE_TYPE, new File(outFile));
    }

    //--------------------------------------------------------------------------

    private String getFileName(String file, boolean small) {
        int pos = file.lastIndexOf('.');

        if (pos != -1)
            file = file.substring(0, pos);

        return small ? file + SMALL_SUFFIX + "." + IMAGE_TYPE : file + "." + IMAGE_TYPE;
    }

    //--------------------------------------------------------------------------

    public BufferedImage getImage(String inFile) throws IOException {
        String lcFile = inFile.toLowerCase();

        if (lcFile.endsWith(".tif") || lcFile.endsWith(".tiff")) {
            //--- load the TIFF/GEOTIFF file format

            Image image = getTiffImage(inFile);

            int width = image.getWidth(null);
            int height = image.getHeight(null);

            BufferedImage bimg = new BufferedImage(width, height, BufferedImage.TYPE_3BYTE_BGR);
            Graphics2D g = bimg.createGraphics();
            g.drawImage(image, 0, 0, null);
            g.dispose();

            return bimg;
        }

        return ImageIO.read(new File(inFile));
    }

    //--------------------------------------------------------------------------

    private Image getTiffImage(String inFile) throws IOException {
        Tiff t = new Tiff();
        t.readInputStream(new FileInputStream(inFile));

        if (t.getPageCount() == 0)
            throw new IOException("No images inside TIFF file");

        return t.getImage(0);
    }

    /**
     * Return file name from full url thumbnail formated as
     * http://wwwmyCatalogue.com:8080/srv/eng/resources.get?uuid=34baff6e-3880-4589-a5e9-4aa376ecd2a5&fname=snapshot3.png
     * @param file
     * @return
     */
    private String getFileName(String file) {
        if (file.indexOf(FNAME_PARAM) < 0) {
            return file;
        } else {
            return file.substring(file.lastIndexOf(FNAME_PARAM) + FNAME_PARAM.length());
        }
    }

    //--------------------------------------------------------------------------
    //---
    //--- Variables
    //---
    //--------------------------------------------------------------------------

    private static final String IMAGE_TYPE = "png";
    private static final String SMALL_SUFFIX = "_s";
    private static final String FNAME_PARAM = "fname=";

}