DataUpdaterCallBack

package fr.ifremer.quadrige2.ui.swing.common.callback;

/*-
 * #%L
 * Quadrige2 Core :: Quadrige2 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.base.Charsets;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.io.Files;
import fr.ifremer.quadrige2.ui.swing.common.ApplicationUIContext;
import fr.ifremer.quadrige2.ui.swing.common.action.AbstractAction;
import fr.ifremer.quadrige2.ui.swing.common.model.ProgressionModel;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuiton.jaxx.application.ApplicationTechnicalException;
import org.nuiton.jaxx.application.swing.action.ApplicationActionException;
import org.nuiton.updater.ApplicationInfo;
import org.nuiton.updater.ApplicationUpdater;
import org.nuiton.updater.ApplicationUpdaterCallback;

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

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

/**
 * CallBack to update i18n, help and config.
 *
 * @author Ludovic Pecquot
 * @since 1.2.2
 */
public class DataUpdaterCallBack implements ApplicationUpdaterCallback {

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

    public enum UpdateType {

        I18N(n("quadrige2.update.i18n")),
        HELP(n("quadrige2.update.help")),
        CONFIG(n("quadrige2.update.config"));

        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 ProgressionModel progressionModel;

    protected boolean dataUpdated;

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

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

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

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

    /** {@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.I18N.name().toLowerCase().equals(info.name)) {
            progressionModel.setMessage(t("quadrige2.applicationUpdater.startUpdate.i18n", info.newVersion));
        }
        if (UpdateType.HELP.name().toLowerCase().equals(info.name)) {
            progressionModel.setMessage(t("quadrige2.applicationUpdater.startUpdate.help", info.newVersion));
        }
        if (UpdateType.CONFIG.name().toLowerCase().equals(info.name)) {
            progressionModel.setMessage(t("quadrige2.applicationUpdater.startUpdate.config", info.newVersion));
        }
    }

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

        boolean updateI18n = updateDoneI18n(appToUpdate, appUpdateError);
        boolean updateHelp = updateDoneHelp(appToUpdate, appUpdateError);
        boolean updateConfig = updateDoneConfig(appToUpdate, appUpdateError);

        boolean doRestart = updateI18n || updateHelp || updateConfig;

        if (doRestart) {
            dataUpdated = 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>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("quadrige2.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("quadrige2.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>updateDoneConfig.</p>
     *
     * @param appToUpdate a {@link Map} object.
     * @param appUpdateError a {@link Map} object.
     * @return a boolean.
     */
    protected boolean updateDoneConfig(Map<String, ApplicationInfo> appToUpdate,
        Map<String, Exception> appUpdateError) {
        boolean doRestart = false;
        Exception error = getError(UpdateType.CONFIG, appUpdateError);
        if (error != null) {

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

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

            // Get the new config file
            try {

                // Load file
                Properties p = new Properties();
                File f = new File(info.destDir, "config/" + context.getConfiguration().getApplicationConfig().getConfigFileName());
                p.load(Files.newReader(f, Charsets.UTF_8));

                // Updates or create missing properties and save all
                context.getConfiguration().overridesOptions(p);
                context.getConfiguration().save();

                // Create local version.appup
                ApplicationUpdater.createVersionFile(context.getConfiguration().getConfigDirectory(), info.newVersion);

            } catch (IOException ex) {
                throw ApplicationActionException.propagateError(
                    action, new ApplicationTechnicalException(t("quadrige2.applicationUpdater.config.io.error"), ex));
            }
        }
        return doRestart;
    }

    /**
     * <p>getInfo.</p>
     *
     * @param type a {@link DataUpdaterCallBack.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 DataUpdaterCallBack.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());
    }
}