Application: gvSIG desktop

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * 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 Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 {Prodevelop}   {Task}

 */

package org.gvsig.installer.lib.impl.creation;

import java.io.BufferedReader;

import java.io.ByteArrayInputStream;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileOutputStream;

import java.io.FileReader;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.installer.lib.api.InstallerManager;

import org.gvsig.installer.lib.api.PackageInfo;

import org.gvsig.installer.lib.api.creation.MakePluginPackageService;

import org.gvsig.installer.lib.api.creation.MakePluginPackageServiceException;

import org.gvsig.installer.lib.impl.DefaultPackageInfo;

import org.gvsig.installer.lib.spi.InstallPackageProviderServices;

import org.gvsig.installer.lib.spi.InstallerProviderLocator;

import org.gvsig.tools.service.Manager;

/**

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public class DefaultMakePluginPackageService implements

    MakePluginPackageService {

    private static final Logger LOG = LoggerFactory

        .getLogger(DefaultMakePluginPackageService.class);

    public static final String ANT_FILE_NAME = "install.xml";

    public static final String COPIED_FILES_DIRECTORY_NAME = "files";

    private File pluginsDirectory;

    private static final Logger logger = org.slf4j.LoggerFactory

        .getLogger(DefaultMakePluginPackageService.class);

    private final InstallerManager manager;

    private List<PackageInfo> installerInfos = null;

    private Map<PackageInfo, String> directories = null;

    protected List<File> selectedFiles = null;

    protected String antScript = null;

    private InstallPackageProviderServices installerProviderServices = null;

    public DefaultMakePluginPackageService(InstallerManager manager,

        File pluginsDirectory) throws MakePluginPackageServiceException {

        super();

        this.manager = manager;

        installerInfos = new ArrayList<PackageInfo>();

        directories = new HashMap<PackageInfo, String>();

        selectedFiles = new ArrayList<File>();

        installerProviderServices =

            InstallerProviderLocator.getProviderManager()

                .createInstallerProviderServices();

        initialize(pluginsDirectory);

    }

    private void initialize(File pluginsDirectory)

        throws MakePluginPackageServiceException {

        if ((!pluginsDirectory.exists()) || (!pluginsDirectory.isDirectory())) {

            throw new MakePluginPackageServiceException(

                "The plugins directory does't exists or not is a directory");

        }

        this.pluginsDirectory = pluginsDirectory;

        // Read all the installed plugins

        String[] plugins = pluginsDirectory.list();

        if (plugins != null) {

            for (int i = 0; i < plugins.length; i++) {

                String pluginDirectoryName = plugins[i];

                File pluginDirectoryFile =

                    getAbsolutePluginPackageDirectory(pluginDirectoryName);

                DefaultPackageInfo packageInfo = new DefaultPackageInfo();

                installerProviderServices.readPackageInfo(new File(

                    pluginDirectoryFile.getAbsolutePath()), packageInfo);

                // Checks if the ant file exists

                File antFile = getAntFile(pluginDirectoryFile);

                if (antFile.exists()) {

                    try {

                        packageInfo.setAnScript(readFileAsString(antFile

                            .getAbsolutePath()));

                    } catch (IOException e) {

                        logger.error("Not possible to read the ant file");

                    }

                }

                // Checks if there are files to copy

                File copiedFilesDirectory =

                    getCopiedFilesDirectory(pluginDirectoryFile);

                if (copiedFilesDirectory.exists()) {

                    loadCopiedFiles(copiedFilesDirectory, copiedFilesDirectory,

                        packageInfo);

                }

                installerInfos.add(packageInfo);

                directories.put(packageInfo, pluginDirectoryName);

            }

        }

    }

    private void loadCopiedFiles(File file, File filesDirectory,

        PackageInfo packageInfo) throws MakePluginPackageServiceException {

        if (file.isDirectory()) {

            File[] files = file.listFiles();

            for (int i = 0; i < files.length; i++) {

                loadCopiedFiles(files[i], filesDirectory, packageInfo);

            }

        } else {

            // Removing the plugin prefix

            String pluginFileName =

                file.getAbsolutePath().substring(

                    filesDirectory.getAbsolutePath().length(),

                    file.getAbsolutePath().length());

            // Ading the root directory

            File pluginFile =

                new File(pluginsDirectory.getParentFile().getParentFile()

                    .getAbsolutePath()

                    + pluginFileName);

            packageInfo.addFileToCopy(pluginFile);

        }

    }

    public void createPackageSet(PackageInfo packageInfo,

        OutputStream packageStream) throws MakePluginPackageServiceException {

        LOG.debug("Creating a package set of the package info: \n{0}",

            packageInfo);

        writeAdditionalFiles(packageInfo);

        String pluginFileName = manager.getPackageFileName(packageInfo);

        installerProviderServices.compressPackageSet(

            getAbsolutePluginPackageDirectory(packageInfo), pluginFileName,

            packageStream);

    }

    private void writeAdditionalFiles(PackageInfo packageInfo)

        throws MakePluginPackageServiceException {

        // Write the package.info file

        writePackageInfo(packageInfo);

        if (packageInfo.getAntScript() != null) {

            // Create the ant file

            writeAntFile(packageInfo);

            // Copy the selected files

            writeSelectedFiles(packageInfo);

        }

    }

    public void createPackage(PackageInfo packageInfo,

        OutputStream packageStream) throws MakePluginPackageServiceException {

        LOG.debug("Creating package of the package info: \n{0}", packageInfo);

        writeAdditionalFiles(packageInfo);

        installerProviderServices.compressPackage(

            getAbsolutePluginPackageDirectory(packageInfo), packageStream);

    }

    private void writePackageInfo(PackageInfo packageInfo)

        throws MakePluginPackageServiceException {

        writePackageInfo(packageInfo,

            getAbsolutePluginPackageDirectory(packageInfo));

    }

    public void writePackageInfo(PackageInfo packageInfo, File folder)

        throws MakePluginPackageServiceException {

        installerProviderServices.writePackageInfo(folder, packageInfo);

    }

    private void writeAntFile(PackageInfo packageInfo)

        throws MakePluginPackageServiceException {

        try {

            ByteArrayInputStream in =

                new ByteArrayInputStream(packageInfo.getAntScript().getBytes());

            OutputStream out =

                new FileOutputStream(getAbsoluteAntFile(packageInfo));

            // Copy the bits from instream to outstream

            byte[] buf = new byte[1024];

            int len;

            while ((len = in.read(buf)) > 0) {

                out.write(buf, 0, len);

            }

            in.close();

            out.close();

        } catch (IOException e) {

            throw new MakePluginPackageServiceException(

                "Exception writing the ant file");

        }

    }

    private void writeSelectedFiles(PackageInfo packageInfo)

        throws MakePluginPackageServiceException {

        try {

            String copiedFilesDirectoryName =

                getAbsoulteCopiedFilesDirectoryName(packageInfo);

            // Deleting the previous files folder

            File copiedFilesDirectoryfile = new File(copiedFilesDirectoryName);

            deleteDirectory(copiedFilesDirectoryfile);

            // It works if the plugins directory is in the folder

            // "gvSIG/extensiones"

            String applicationDirectory =

                pluginsDirectory.getParentFile().getParent();

            for (int i = 0; i < packageInfo.getFileToCopySize(); i++) {

                String sourceFile =

                    packageInfo.getFileToCopyAt(i).getAbsolutePath();

                // Create the final path

                String destFile =

                    sourceFile.substring(applicationDirectory.length(),

                        sourceFile.length());

                destFile = copiedFilesDirectoryName + destFile;

                // Copy the files

                copy(new File(sourceFile), new File(destFile));

            }

        } catch (IOException e) {

            throw new MakePluginPackageServiceException(

                "Exception copying the files");

        }

    }

    static public boolean deleteDirectory(File path) {

        if (path.exists()) {

            File[] files = path.listFiles();

            for (int i = 0; i < files.length; i++) {

                if (files[i].isDirectory()) {

                    deleteDirectory(files[i]);

                } else {

                    files[i].delete();

                }

            }

        }

        return (path.delete());

    }

    void copy(File sourceLocation, File targetLocation) throws IOException {

        if (sourceLocation.isDirectory()) {

            if (!targetLocation.exists()) {

                targetLocation.mkdir();

            }

            String[] children = sourceLocation.list();

            for (int i = 0; i < children.length; i++) {

                copy(new File(sourceLocation, children[i]), new File(

                    targetLocation, children[i]));

            }

        } else {

            targetLocation.getParentFile().mkdirs();

            InputStream in = new FileInputStream(sourceLocation);

            OutputStream out = new FileOutputStream(targetLocation);

            // Copy the bits from instream to outstream

            byte[] buf = new byte[1024];

            int len;

            while ((len = in.read(buf)) > 0) {

                out.write(buf, 0, len);

            }

            in.close();

            out.close();

        }

    }

    private String getPluginPackageDirectory(PackageInfo packageInfo) {

        return directories.get(packageInfo);

    }

    private String getCopiedFilesDirectoryName(PackageInfo packageInfo)

        throws MakePluginPackageServiceException {

        return getPluginPackageDirectory(packageInfo) + File.separator

            + COPIED_FILES_DIRECTORY_NAME;

    }

    private File getCopiedFilesDirectory(File pluginDirectory)

        throws MakePluginPackageServiceException {

        return new File(pluginDirectory.getAbsolutePath() + File.separator

            + COPIED_FILES_DIRECTORY_NAME);

    }

    private String getAbsoulteCopiedFilesDirectoryName(PackageInfo packageInfo)

        throws MakePluginPackageServiceException {

        return getAbsolutePluginPackageDirectory(packageInfo).getAbsolutePath()

            + File.separator + COPIED_FILES_DIRECTORY_NAME;

    }

    private String getAntFileName(PackageInfo packageInfo)

        throws MakePluginPackageServiceException {

        return getPluginPackageDirectory(packageInfo) + File.separator

            + ANT_FILE_NAME;

    }

    private File getAntFile(File pluginDirectory)

        throws MakePluginPackageServiceException {

        return new File(pluginDirectory.getAbsolutePath() + File.separator

            + ANT_FILE_NAME);

    }

    private File getAbsoluteAntFile(PackageInfo packageInfo)

        throws MakePluginPackageServiceException {

        return new File(pluginsDirectory.getAbsolutePath() + File.separator

            + getAntFileName(packageInfo));

    }

    private File getAbsolutePluginPackageDirectory(PackageInfo packageInfo)

        throws MakePluginPackageServiceException {

        return new File(pluginsDirectory.getAbsolutePath() + File.separator

            + getPluginPackageDirectory(packageInfo));

    }

    private File getAbsolutePluginPackageDirectory(String pluginDirectory)

        throws MakePluginPackageServiceException {

        return new File(pluginsDirectory.getAbsolutePath() + File.separator

            + pluginDirectory);

    }

    public Manager getManager() {

        return this.manager;

    }

    public PackageInfo getPluginPackageInfo(int index) {

        if (index >= installerInfos.size()) {

            return null;

        }

        return installerInfos.get(index);

    }

    public PackageInfo getPluginPackageInfo(String code) {

        for (int i = 0; i < getPluginPackageCount(); i++) {

            if (installerInfos.get(i).getCode().equals(code)) {

                return installerInfos.get(i);

            }

        }

        return null;

    }

    public int getPluginPackageCount() {

        return installerInfos.size();

    }

    public String getDefaultAntScript()

        throws MakePluginPackageServiceException {

        try {

            return readFileAsString(getClass().getClassLoader()

                .getResource(ANT_FILE_NAME).getFile());

        } catch (IOException e) {

            throw new MakePluginPackageServiceException(

                "Impossible to read the default ant file", e);

        }

    }

    private String readFileAsString(String filePath) throws java.io.IOException {

        StringBuffer fileData = new StringBuffer(1000);

        BufferedReader reader = new BufferedReader(new FileReader(filePath));

        char[] buf = new char[1024];

        int numRead = 0;

        while ((numRead = reader.read(buf)) != -1) {

            String readData = String.valueOf(buf, 0, numRead);

            fileData.append(readData);

            buf = new char[1024];

        }

        reader.close();

        return fileData.toString();

    }

    public File getPluginsDirectory() {

        return pluginsDirectory;

    }

    public PackageInfo[] getInstalledPackages()

        throws MakePluginPackageServiceException {

        return installerInfos.toArray(new PackageInfo[installerInfos.size()]);

    }

}