ApplicationUpdaterCallBack

package fr.ifremer.quadrige3.ui.swing.callback;

/*-
 * #%L
 * Quadrige3 Core :: Quadrige3 UI Common
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2017 Ifremer
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 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 Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */


import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import fr.ifremer.quadrige3.ui.swing.ApplicationUIContext;
import fr.ifremer.quadrige3.ui.swing.action.AbstractAction;
import fr.ifremer.quadrige3.ui.swing.model.ProgressionUIModel;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuiton.jaxx.application.ApplicationIOUtil;
import org.nuiton.jaxx.application.ApplicationTechnicalException;
import org.nuiton.jaxx.application.swing.action.ApplicationActionException;
import org.nuiton.updater.ApplicationInfo;

import java.io.File;
import java.util.List;
import java.util.Map;

import static org.nuiton.i18n.I18n.n;
import static org.nuiton.i18n.I18n.t;

/**
 * CallBack to update jre, application, i18n.
 *
 * @since 1.0
 */
public class ApplicationUpdaterCallBack implements org.nuiton.updater.ApplicationUpdaterCallback {

    /** Logger. */
    private static final Log LOG = LogFactory.getLog(ApplicationUpdaterCallBack.class);

    public enum UpdateType {
        LAUNCHER(n("quadrige3.update.launcher")),
        JRE(n("quadrige3.update.jre")),
        APPLICATION(n("quadrige3.update.application")),
        I18N(n("quadrige3.update.i18n")),
        HELP(n("quadrige3.update.help"));

        private final String i18nKey;

        UpdateType(String i18nKey) {
            this.i18nKey = i18nKey;
        }

        public String getLabel() {
            return t(i18nKey);
        }
    }

    protected final ApplicationUIContext context;

    protected List<UpdateType> types;

    protected final ProgressionUIModel progressionModel;

    protected boolean applicationUpdated;

    protected final AbstractAction<?, ?, ?> action;

    /**
     * <p>Constructor for ApplicationUpdaterCallBack.</p>
     *
     * @param action a {@link AbstractAction} object.
     * @param progressionModel a {@link ProgressionUIModel} object.
     */
    public ApplicationUpdaterCallBack(AbstractAction<?, ?, ?> action, ProgressionUIModel progressionModel) {
        this.action = action;
        this.context = action.getContext();
        this.progressionModel = progressionModel;
    }

    /**
     * <p>Setter for the field <code>types</code>.</p>
     *
     * @param types a {@link ApplicationUpdaterCallBack.UpdateType} object.
     */
    public void setTypes(UpdateType... types) {
        this.types = Lists.newArrayList(types);
    }

    /**
     * <p>isApplicationUpdated.</p>
     *
     * @return a boolean.
     */
    public boolean isApplicationUpdated() {
        return applicationUpdated;
    }

    /** {@inheritDoc} */
    @Override
    public Map<String, ApplicationInfo> updateToDo(Map<String, ApplicationInfo> appToUpdate) {
        Map<String, ApplicationInfo> result = Maps.newHashMap();

        for (UpdateType type : types) {
            ApplicationInfo info = getInfo(type, appToUpdate);
            if (info != null) {
                result.put(info.name, info);
            }
        }
        return result;
    }

    /** {@inheritDoc} */
    @Override
    public void startUpdate(ApplicationInfo info) {
        if (UpdateType.LAUNCHER.name().toLowerCase().equals(info.name)) {
            progressionModel.setMessage(t("quadrige3.applicationUpdater.startUpdate.launcher", info.newVersion));
        }

        if (UpdateType.JRE.name().toLowerCase().equals(info.name)) {
            progressionModel.setMessage(t("quadrige3.applicationUpdater.startUpdate.jre", info.newVersion));
        }

        if (UpdateType.APPLICATION.name().toLowerCase().equals(info.name)) {
            progressionModel.setMessage(t("quadrige3.applicationUpdater.startUpdate.application", info.newVersion));
        }

        if (UpdateType.I18N.name().toLowerCase().equals(info.name)) {
            progressionModel.setMessage(t("quadrige3.applicationUpdater.startUpdate.i18n", info.newVersion));
        }
        if (UpdateType.HELP.name().toLowerCase().equals(info.name)) {
            progressionModel.setMessage(t("quadrige3.applicationUpdater.startUpdate.help", info.newVersion));
        }
    }

    /** {@inheritDoc} */
    @Override
    public void updateDone(Map<String, ApplicationInfo> appToUpdate,
                           Map<String, Exception> appUpdateError) {

        boolean updateLauncher = updateDoneLauncher(appToUpdate, appUpdateError);
        boolean updateJRE = updateDoneJre(appToUpdate, appUpdateError);
        boolean updateApplication = updateDoneApplication(appToUpdate, appUpdateError);
        boolean updateI18n = updateDoneI18n(appToUpdate, appUpdateError);
        boolean updateHelp = updateDoneHelp(appToUpdate, appUpdateError);

        boolean doRestart = updateLauncher || updateJRE || updateApplication || updateI18n || updateHelp;

        if (doRestart) {
            applicationUpdated = true;
        }
    }

    /** {@inheritDoc} */
    @Override
    public void aborted(String propertiesURL, Exception eee) {
        if (LOG.isErrorEnabled()) {
            LOG.error("Could not update from " + propertiesURL, eee);
        }
        throw ApplicationActionException.propagateError(action, eee);
    }

    /**
     * <p>updateDoneLauncher.</p>
     *
     * @param appToUpdate a {@link Map} object.
     * @param appUpdateError a {@link Map} object.
     * @return a boolean.
     */
    protected boolean updateDoneLauncher(Map<String, ApplicationInfo> appToUpdate, Map<String, Exception> appUpdateError) {

        boolean doRestart = false;
        Exception error = getError(UpdateType.LAUNCHER, appUpdateError);
        if (error != null) {

            // something bad while updating launcher
            throw ApplicationActionException.propagateError(
                    action, new ApplicationTechnicalException(t("quadrige3.applicationUpdater.launcher.error"), error));
        } else {
            ApplicationInfo info = getInfo(UpdateType.LAUNCHER, appToUpdate);
            if (info != null) {

                if (LOG.isInfoEnabled()) {
                    LOG.info(String.format(
                            "A launcher update was downloaded (oldVersion: %s, newVersion: %s), will restart application to use it",
                            info.oldVersion, info.newVersion));
                }
                doRestart = true;
            }
        }
        return doRestart;

    }

    /**
     * <p>updateDoneJre.</p>
     *
     * @param appToUpdate a {@link Map} object.
     * @param appUpdateError a {@link Map} object.
     * @return a boolean.
     */
    protected boolean updateDoneJre(Map<String, ApplicationInfo> appToUpdate,
                                    Map<String, Exception> appUpdateError) {
        boolean doRestart = false;
        Exception error = getError(UpdateType.JRE, appUpdateError);
        if (error != null) {

            // something bad while updating jre
            throw ApplicationActionException.propagateError(
                    action, new ApplicationTechnicalException(t("quadrige3.applicationUpdater.jre.error"), error));
        }
        ApplicationInfo info = getInfo(UpdateType.JRE, appToUpdate);
        if (info != null) {
            if (LOG.isInfoEnabled()) {
                LOG.info(String.format(
                        "A jre update was downloaded (oldVersion: %s, newVersion: %s), will restart application to use it",
                        info.oldVersion, info.newVersion));
            }
            doRestart = true;
        }
        return doRestart;
    }

    /**
     * <p>updateDoneApplication.</p>
     *
     * @param appToUpdate a {@link Map} object.
     * @param appUpdateError a {@link Map} object.
     * @return a boolean.
     */
    protected boolean updateDoneApplication(Map<String, ApplicationInfo> appToUpdate,
                                            Map<String, Exception> appUpdateError) {
        boolean doRestart = false;
        Exception error = getError(UpdateType.APPLICATION, appUpdateError);
        if (error != null) {

            // something bad while updating application
            throw ApplicationActionException.propagateError(
                    action, new ApplicationTechnicalException(t("quadrige3.applicationUpdater.application.error"), error));
        }
        ApplicationInfo info = getInfo(UpdateType.APPLICATION, appToUpdate);
        if (info != null) {

            if (LOG.isInfoEnabled()) {
                LOG.info(String.format(
                        "A application update was downloaded (oldVersion: %s, newVersion: %s), will restart application to use it",
                        info.oldVersion, info.newVersion));
            }
            doRestart = true;

            //FIXME-check this is necessary: i18n is no more generated ?
            // must also remove i18n directory
            File i18nDirectory = context.getConfiguration().getI18nDirectory();
            ApplicationIOUtil.forceDeleteOnExit(
                    i18nDirectory,
                    t("quadrige3.applicationUpdater.updateDone.deleteDirectory.i18n.error", i18nDirectory)
            );

            // must remove db cache directory
            File cacheDirectory = context.getConfiguration().getCacheDirectory();
            ApplicationIOUtil.forceDeleteOnExit(
                    cacheDirectory,
                    t("quadrige3.applicationUpdater.updateDone.deleteDirectory.caches.error", cacheDirectory)
            );
        }
        return doRestart;
    }

    /**
     * <p>updateDoneI18n.</p>
     *
     * @param appToUpdate a {@link Map} object.
     * @param appUpdateError a {@link Map} object.
     * @return a boolean.
     */
    protected boolean updateDoneI18n(Map<String, ApplicationInfo> appToUpdate,
                                     Map<String, Exception> appUpdateError) {
        boolean doRestart = false;
        Exception error = getError(UpdateType.I18N, appUpdateError);
        if (error != null) {

            // something bad while updating i18n
            throw ApplicationActionException.propagateError(
                    action, new ApplicationTechnicalException(t("quadrige3.applicationUpdater.i18n.error"), error));
        }
        ApplicationInfo info = getInfo(UpdateType.I18N, appToUpdate);
        if (info != null) {

            if (LOG.isInfoEnabled()) {
                LOG.info(String.format(
                        "A i18n update was downloaded (oldVersion: %s, newVersion: %s), will restart application to use it",
                        info.oldVersion, info.newVersion));
            }
            doRestart = true;
        }
        return doRestart;
    }

    /**
     * <p>updateDoneHelp.</p>
     *
     * @param appToUpdate a {@link Map} object.
     * @param appUpdateError a {@link Map} object.
     * @return a boolean.
     */
    protected boolean updateDoneHelp(Map<String, ApplicationInfo> appToUpdate,
                                     Map<String, Exception> appUpdateError) {
        boolean doRestart = false;
        Exception error = getError(UpdateType.HELP, appUpdateError);
        if (error != null) {

            // something bad while updating help
            throw ApplicationActionException.propagateError(
                    action, new ApplicationTechnicalException(t("quadrige3.applicationUpdater.help.error"), error));
        }
        ApplicationInfo info = getInfo(UpdateType.HELP, appToUpdate);
        if (info != null) {

            if (LOG.isInfoEnabled()) {
                LOG.info(String.format(
                        "A help update was downloaded (oldVersion: %s, newVersion: %s), will restart application to use it",
                        info.oldVersion, info.newVersion));
            }
            doRestart = true;
        }
        return doRestart;
    }

    /**
     * <p>getInfo.</p>
     *
     * @param type a {@link ApplicationUpdaterCallBack.UpdateType} object.
     * @param appToUpdate a {@link Map} object.
     * @return a {@link ApplicationInfo} object.
     */
    protected ApplicationInfo getInfo(UpdateType type, Map<String, ApplicationInfo> appToUpdate) {
        return appToUpdate.get(type.name().toLowerCase());
    }

    /**
     * <p>getError.</p>
     *
     * @param type a {@link ApplicationUpdaterCallBack.UpdateType} object.
     * @param appUpdateError a {@link Map} object.
     * @return a {@link Exception} object.
     */
    protected Exception getError(UpdateType type, Map<String, Exception> appUpdateError) {
        return appUpdateError.get(type.name().toLowerCase());
    }
}