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.execution;

import java.io.BufferedInputStream;

import java.io.File;

import java.io.FileFilter;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.io.InputStream;

import java.net.MalformedURLException;

import java.net.URL;

import java.util.ArrayList;

import java.util.Collections;

import java.util.HashMap;

import java.util.HashSet;

import java.util.List;

import java.util.Map;

import java.util.Set;

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.Version;

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

import org.gvsig.installer.lib.api.execution.InstallPackageService;

import org.gvsig.installer.lib.api.execution.InstallPackageServiceException;

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

import org.gvsig.installer.lib.impl.utils.Download;

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

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

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

import org.gvsig.installer.lib.spi.execution.InstallPackageProvider;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.service.Manager;

import org.gvsig.tools.service.ServiceException;

import org.gvsig.tools.task.SimpleTaskStatus;

/**

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

 */

public class DefaultInstallPackageService extends Thread implements

                InstallPackageService {

        private static final Logger LOG = LoggerFactory

                        .getLogger(DefaultInstallPackageService.class);

        private static final String PACKAGE_FILE_NAME = "packages.gvspki";

        private Map<PackageInfo, File> packageInfoFileMap = null;

        private Map<PackageInfo, String> zipEntriesMap = null;

        private List<PackageInfo> packageInfos = null;

        private InstallerManager manager;

        private InstallPackageProviderServices installerProviderServices = null;

        public DefaultInstallPackageService(DefaultInstallerManager manager) {

                super();

                this.manager = manager;

                this.reset();

        }

        public void reset() {

                packageInfoFileMap = new HashMap<PackageInfo, File>();

                packageInfos = new ArrayList<PackageInfo>();

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

                installerProviderServices = InstallerProviderLocator

                                .getProviderManager().createInstallerProviderServices();

        }

        public class InstallerApplicationDirectoryNotFoundException extends

                        InstallPackageServiceException {

                private static final long serialVersionUID = -1130408094135962456L;

                private static final String message = "Aplication directory '%(directory)s' not found";

                private static final String KEY = "_aplication_directory_XdirectoryX_not_found";

                public InstallerApplicationDirectoryNotFoundException(File file) {

                        super(message, KEY, serialVersionUID);

                        setValue("directory", file.toString());

                }

        }

        public class InstallerNoDirectoryException extends

                        InstallPackageServiceException {

                private static final long serialVersionUID = -8685263049644983769L;

                private static final String message = "'%(directory)s' is not a directory";

                private static final String KEY = "_XdirectoryX_is_not_a_directory";

                public InstallerNoDirectoryException(File file) {

                        super(message, KEY, serialVersionUID);

                        setValue("directory", file.toString());

                }

        }

        public class InstallerFileNotFoundException extends

                        InstallPackageServiceException {

                private static final long serialVersionUID = 556517830330132149L;

                private static final String message = "File '%(file)s' not found";

                private static final String KEY = "_file_XfileX_not_found";

                public InstallerFileNotFoundException(File file) {

                        super(message, KEY, serialVersionUID);

                        setValue("file", file.toString());

                }

        }

        public class InstallerBundleNotFoundException extends

                        InstallPackageServiceException {

                private static final long serialVersionUID = 5065410511582625301L;

                private static final String message = "File '%(file)s' not found";

                private static final String KEY = "_file_XfileX_not_found";

                public InstallerBundleNotFoundException(File file,

                                FileNotFoundException e) {

                        super(message, e, KEY, serialVersionUID);

                        setValue("file", file.toString());

                }

        }

        public class InstallerIOException extends InstallPackageServiceException {

                private static final long serialVersionUID = 3153613550157712363L;

                private static final String message = "IO error installing the file '%(file)s'";

                private static final String KEY = "_IO_error installing_file_XfileX_";

                public InstallerIOException(File file, IOException e) {

                        super(message, e, KEY, serialVersionUID);

                        setValue("file", file.toString());

                }

        }

        public class InstallerFileDownloadException extends

                        InstallPackageServiceException {

                private static final long serialVersionUID = 8640183295766490512L;

                private static final String message = "File '%(url)s' download error";

                private static final String KEY = "_File_XurlX_download_error";

                public InstallerFileDownloadException(URL url, IOException e) {

                        super(message, e, KEY, serialVersionUID);

                        setValue("url", url.toString());

                }

        }

        public class InstallerPackageNotFoundException extends

                        InstallPackageServiceException {

                private static final long serialVersionUID = 1726608498886963868L;

                private static final String message = "Package not found";

                private static final String KEY = "_package_not_found";

                public InstallerPackageNotFoundException() {

                        super(message, KEY, serialVersionUID);

                }

        }

        public class InstallerNoPackageException extends

                        InstallPackageServiceException {

                private static final long serialVersionUID = -2292735515704746966L;

                private static final String message = "Package does not exist";

                private static final String KEY = "_package__does_not_exist";

                public InstallerNoPackageException() {

                        super(message, KEY, serialVersionUID);

                }

        }

        public class InstallerProviderCreationException extends

                        InstallPackageServiceException {

                private static final long serialVersionUID = -7985786807492393584L;

                private static final String message = "Error creating the provider";

                private static final String KEY = "_Error_creating_the_provider";

                public InstallerProviderCreationException(ServiceException e) {

                        super(message, e, KEY, serialVersionUID);

                }

        }

        public void installPackage(File applicationDirectory,

                        PackageInfo packageInfo) throws InstallPackageServiceException {

                if (!applicationDirectory.exists()) {

                        throw new InstallerApplicationDirectoryNotFoundException(

                                        applicationDirectory);

                }

                if (!packageInfoFileMap.containsKey(packageInfo)) {

                        throw new InstallerPackageNotFoundException();

                }

                InstallPackageProvider installerExecutionProvider = createProvider(packageInfo);

                // Get the package or package set file

                File file = packageInfoFileMap.get(packageInfo);

                if (file == null) {

                        if (packageInfo.getDownloadURL() == null) {

                                throw new InstallerPackageNotFoundException();

                        }

                        this.downloadPackage(packageInfo);

                        file = packageInfoFileMap.get(packageInfo);

                }

                // Open and install the package or package set file

                try {

                        InputStream packageStream;

                        InputStream fis = new FileInputStream(file);

                        InputStream bis = new BufferedInputStream(fis);

                        if (isPackage(file)) {

                                packageStream = bis;

                        } else {

                                if (!isPackageSet(file)) {

                                        LOG.info("Trying to install a package file ({0}) "

                                                        + "without a known file extension. Will try "

                                                        + "to install it as a package set", file);

                                }

                                packageStream = installerProviderServices.searchPackage(bis,

                                                zipEntriesMap.get(packageInfo));

                        }

                        try {

                                installerExecutionProvider.install(applicationDirectory,

                                                packageStream, packageInfo);

                        } catch (InstallPackageServiceException e) {

                                packageStream.close();

                                if (bis != packageStream) {

                                        bis.close();

                                }

                                fis.close();

                                // if fails the installation, zip files need to be reopen

                                // the package will be installed into the update folder for

                                // installation after a gvSIG restart

                                fis = new FileInputStream(file);

                                bis = new BufferedInputStream(fis);

                                if (isPackage(file)) {

                                        packageStream = bis;

                                } else {

                                        if (!isPackageSet(file)) {

                                                LOG.info("Trying to install a package file ({0}) "

                                                                + "without a known file extension. Will try "

                                                                + "to install it as a package set", file);

                                        }

                                        packageStream = installerProviderServices.searchPackage(

                                                        bis, zipEntriesMap.get(packageInfo));

                                }

                                installerExecutionProvider.installLater(applicationDirectory,

                                                packageStream, packageInfo);

                        }

                        packageStream.close();

                        if (bis != packageStream) {

                                bis.close();

                        }

                        fis.close();

                } catch (FileNotFoundException e) {

                        throw new InstallerFileNotFoundException(file);

                } catch (IOException e) {

                        throw new InstallerIOException(file, e);

                }

        }

        public void installPackage(File applicationDirectory, String packageCode)

                        throws InstallPackageServiceException {

                PackageInfo packageInfo = getPackageInfo(packageCode);

                if (packageInfo == null) {

                        throw new InstallerNoPackageException();

                }

                installPackage(applicationDirectory, packageInfo);

        }

        private InstallPackageProvider createProvider(PackageInfo packageInfo)

                        throws InstallPackageServiceException {

                InstallerProviderManager installerProviderManager = (InstallerProviderManager) ((DefaultInstallerManager) manager)

                                .getProviderManager();

                try {

                        return installerProviderManager.createExecutionProvider(packageInfo

                                        .getType());

                } catch (ServiceException e) {

                        throw new InstallerProviderCreationException(e);

                }

        }

        public PackageInfo getPackageInfo(int index) {

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

                        return null;

                }

                return packageInfos.get(index);

        }

        public PackageInfo getPackageInfo(String packageCode) {

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

                        if (packageInfos.get(i).getCode().equals(packageCode)) {

                                return packageInfos.get(i);

                        }

                }

                return null;

        }

        public void addBundle(File bundle) throws InstallPackageServiceException {

                if (!bundle.exists()) {

                        throw new InstallPackageServiceException();

                }

                int packageInfoCount = packageInfos.size();

                FileInputStream fis;

                try {

                        fis = new FileInputStream(bundle);

                } catch (FileNotFoundException e) {

                        throw new InstallerBundleNotFoundException(bundle, e);

                }

                BufferedInputStream bis = new BufferedInputStream(fis);

                if (isPackage(bundle)) {

                        installerProviderServices.readPackageInfo(bis, packageInfos,

                                        zipEntriesMap, bundle.getName());

                } else {

                        if (!isPackageSet(bundle)) {

                                LOG

                                                .info(

                                                                "Trying to add a package file ({0}) without a known "

                                                                                + "file extension. Will try to add it as a package set",

                                                                bundle);

                        }

                        installerProviderServices.readPackageSetInfo(fis, packageInfos,

                                        zipEntriesMap);

                }

                try {

                        bis.close();

                        fis.close();

                } catch (IOException e) {

                        LOG.info("Error closing the input streams of the package file: "

                                        + bundle, e);

                }

                for (int i = packageInfoCount; i < packageInfos.size(); i++) {

                        packageInfoFileMap.put(packageInfos.get(i), bundle);

                }

        }

        private boolean isPackageSet(File file) {

                return file.getName().endsWith(

                                manager.getDefaultPackageSetFileExtension());

        }

        private boolean isPackage(File file) {

                return file.getName()

                                .endsWith(manager.getDefaultPackageFileExtension());

        }

        public void addBundle(URL bundleURL) throws InstallPackageServiceException {

                File bundle;

                String urlString = bundleURL.toString(); 

                if (urlString.endsWith(InstallerManager.PACKAGE_EXTENSION) || urlString.endsWith(InstallerManager.PACKAGE_INDEX_EXTENSION)) {

            manager.setDownloadBaseURL(bundleURL);

                        bundle = downloadFile(bundleURL, PACKAGE_FILE_NAME);

                        addBundle(bundle);

                } else {

                        if (!urlString.endsWith("/")) {

                                urlString += "/";

                        }

                        Version version = manager.getVersionEx(); 

                        urlString += ("dists/"

                        + version.getMayor() + "." + version.getMinor() + "."

                        + version.getRevision() + "/" + PACKAGE_FILE_NAME);

                        URL completeURL;

                        try {

                                completeURL = new URL(urlString);

                        } catch (MalformedURLException e) {

                                // TODO Auto-generated catch block

                                e.printStackTrace();

                                return;

                        }

            manager.setDownloadBaseURL(completeURL);

                        bundle = downloadFile(completeURL, PACKAGE_FILE_NAME);

                        addBundle(bundle);

                }

        }

        private File downloadFile(URL bundleURL, String defaultFileName)

                        throws InstallPackageServiceException {

                try {

                        Download download = new Download();

                        return download.downloadFile(bundleURL, defaultFileName);

                } catch (IOException e) {

                        throw new InstallerFileDownloadException(bundleURL, e);

                }

        }

        public void addBundlesFromDirectory(File directory)

                        throws InstallPackageServiceException {

                if (!directory.isDirectory()) {

                        throw new InstallerNoDirectoryException(directory);

                }

                List<File> files = new ArrayList<File>();

                listRecursively(directory, new FileFilter() {

                        private String packageExt = manager

                                        .getDefaultPackageFileExtension();

                        private String packageSetExt = manager

                                        .getDefaultPackageSetFileExtension();

                        public boolean accept(File file) {

                                String name = file.getName().toLowerCase();

                                return file.isDirectory() || name.endsWith(packageExt)

                                                || name.endsWith(packageSetExt);

                        }

                }, files);

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

                        if (files.get(i).isFile()) {

                                addBundle(files.get(i));

                        }

                }

        }

        private void listRecursively(File fileOrDir, FileFilter filter,

                        List<File> files) {

                files.add(fileOrDir);

                if (fileOrDir.isDirectory()) {

                        File[] dirContents = fileOrDir.listFiles(filter);

                        for (File f : dirContents) {

                                listRecursively(f, filter, files); // Recursively list.

                        }

                } else {

                        files.add(fileOrDir);

                }

        }

        public int getPackageCount() {

                if (packageInfos == null) {

                        return 0;

                }

                return packageInfos.size();

        }

        public Manager getManager() {

                return this.manager;

        }

        public void downloadPackage(PackageInfo packageInfo)

                        throws InstallPackageServiceException {

                this.downloadPackage(packageInfo, null);

        }

        public void downloadPackage(PackageInfo packageInfo,

                        SimpleTaskStatus taskStatus) throws InstallPackageServiceException {

                File file = null;

                try {

            file = packageInfo.downloadFile(taskStatus);

        } catch (BaseException e) {

            throw new InstallPackageServiceException(e);

        }

                this.packageInfoFileMap.put(packageInfo, file);

        }

        public List<String> getDefaultSelectedPackagesIDs() {

                return installerProviderServices.getDefaultSelectedPackagesIDs();

        }

        public List<String> getCategories() {

                Set<String> categories = new HashSet<String>();

                for (int i = 0; i < packageInfos.size(); i++) {

                        PackageInfo pkginfo = packageInfos.get(i);

                        List<String> pkgcategories = pkginfo.getCategories();

                        categories.addAll(pkgcategories);

                }

                try {

                        PackageInfo[] pkgs = manager.getInstalledPackages();

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

                                PackageInfo pkginfo = pkgs[i];

                                List<String> pkgcategories = pkginfo.getCategories();

                                categories.addAll(pkgcategories);

                        }

                } catch (MakePluginPackageServiceException e) {

                        // Ignore exceptions

                }

                ArrayList<String> l = new ArrayList<String>(categories);

                Collections.sort(l);

                return l;

        }

        public List<String> getTypes() {

                Set<String> types = new HashSet<String>();

                for (int i = 0; i < packageInfos.size(); i++) {

                        PackageInfo pkginfo = packageInfos.get(i);

                        types.add(pkginfo.getType());

                }

                try {

                        PackageInfo[] pkgs = manager.getInstalledPackages();

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

                                PackageInfo pkginfo = pkgs[i];

                                types.add(pkginfo.getType());

                        }

                } catch (MakePluginPackageServiceException e) {

                        // Ignore exceptions

                }

                ArrayList<String> l = new ArrayList<String>(types);

                Collections.sort(l);

                return l;

        }

}