Updater.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 The Gridarta Developers.
 *
 * 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.
 */

package net.sf.gridarta.updater;

import java.awt.Component;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InterruptedIOException;
import java.io.OutputStream;
import java.net.Proxy;
import java.net.URL;
import java.net.URLConnection;
import java.net.UnknownHostException;
import java.util.MissingResourceException;
import java.util.PropertyResourceBundle;
import java.util.ResourceBundle;
import java.util.prefs.Preferences;
import javax.swing.JOptionPane;
import javax.swing.ProgressMonitor;
import javax.swing.ProgressMonitorInputStream;
import net.sf.gridarta.MainControl;
import net.sf.gridarta.gui.dialog.prefs.NetPreferences;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.gridarta.utils.Exiter;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class Updater implements Runnable {

    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");

    @NotNull
    private static final Category LOG = Logger.getLogger(Updater.class);

    @NotNull
    private static final Preferences PREFERENCES = Preferences.userNodeForPackage(MainControl.class);

    @NotNull
    public static final String LAST_UPDATE_KEY = "UpdateTimestamp";

    @Nullable
    private final Component parentComponent;

    @NotNull
    private final Exiter exiter;

    @NotNull
    private final String updateFileName;

    private static final int BUF_SIZE = 4096;

    public Updater(@Nullable final Component parentComponent, @NotNull final Exiter exiter, @NotNull final String updateFileName) {
        this.parentComponent = parentComponent;
        this.exiter = exiter;
        this.updateFileName = updateFileName;
        if (parentComponent != null) {
            parentComponent.setEnabled(false);
        }
    }

    @Override
    public void run() {
        try {
            final String propUrl = ACTION_BUILDER.getString("update.url");
            if (propUrl == null) {
                return;
            }

            try (InputStream pin = openStream(propUrl)) {
                final ResourceBundle updateBundle = new PropertyResourceBundle(pin);
                final String downloadUrl = updateBundle.getString("update.url");
                if (downloadUrl == null) {
                    ACTION_BUILDER.showMessageDialog(parentComponent, "updateError", "invalid server response: update.url is missing");
                    return;
                }
                final VersionInfo update = new VersionInfo(updateBundle, "update");
                VersionInfo active = VersionInfo.UNAVAILABLE;
                try {
                    active = new VersionInfo(ResourceBundle.getBundle("build"), "build");
                } catch (final MissingResourceException e) {
                    ACTION_BUILDER.showMessageDialog(parentComponent, "updateActiveVersionUnavailable");
                }
                PREFERENCES.putLong(LAST_UPDATE_KEY, System.currentTimeMillis());
                if (active == null || update.isNewerThan(active)) {
                    if (askIfUserWantsUpdate(active, update, propUrl, downloadUrl)) {
                        downloadAndInstallUpdate(downloadUrl);
                    }
                } else {
                    noNewUpdate(active, update, propUrl, downloadUrl);
                }
            }
        } catch (final UnknownHostException e) {
            ACTION_BUILDER.showMessageDialog(parentComponent, "updateError", e.getLocalizedMessage());
        } catch (final IOException e) {
            ACTION_BUILDER.showMessageDialog(parentComponent, "updateError", e);
        } finally {
            if (parentComponent != null) {
                parentComponent.setEnabled(true);
            }
        }
    }

    private boolean askIfUserWantsUpdate(@Nullable final VersionInfo active, @NotNull final VersionInfo update, @NotNull final String propUrl, @NotNull final String downloadUrl) {
        return ACTION_BUILDER.showConfirmDialog(parentComponent, JOptionPane.YES_NO_OPTION, JOptionPane.QUESTION_MESSAGE, "updateAvailable", updateFileName, active == null ? "?" : active.version, update.version, active == null ? "?" : active.developer, update.developer, active == null ? "?" : active.timestamp, update.timestamp, propUrl, downloadUrl) == JOptionPane.YES_OPTION;
    }

    private void noNewUpdate(@Nullable final VersionInfo active, @NotNull final VersionInfo update, @NotNull final String propUrl, @NotNull final String downloadUrl) {
        ACTION_BUILDER.showMessageDialog(parentComponent, "updateUnavailable", active == null ? "?" : active.version, update.version, active == null ? "?" : active.developer, update.developer, active == null ? "?" : active.timestamp, update.timestamp, propUrl, downloadUrl);
    }

    private void downloadAndInstallUpdate(@NotNull final String url) {
        final File download = new File(updateFileName + ".tmp"); // TODO: print error message if file already exists
        final File backup = new File(updateFileName + ".bak");
        final File orig = new File(updateFileName);
        try {
            try (InputStream in = openStream(url)) {
                try (OutputStream out = new FileOutputStream(download)) {
                    final byte[] buf = new byte[BUF_SIZE];
                    while (true) {
                        final int bytesRead = in.read(buf);
                        if (bytesRead == -1) {
                            break;
                        }
                        out.write(buf, 0, bytesRead);
                    }
                    out.close();
                    if (/* !backup.delete() || */ !orig.renameTo(backup)) {
                        ACTION_BUILDER.showMessageDialog(parentComponent, "updateFailedNoBackup", updateFileName);
                    } else if (!download.renameTo(orig)) {
                        backup.renameTo(orig);
                        ACTION_BUILDER.showMessageDialog(parentComponent, "updateFailedNoDownload");
                    } else {
                        ACTION_BUILDER.showMessageDialog(parentComponent, "updateRestart", updateFileName);
                        exiter.doExit(0);
                    }
                }
            }
        } catch (final InterruptedIOException e) {
            ACTION_BUILDER.showMessageDialog(parentComponent, "updateAborted");
        } catch (final Exception e) {
            LOG.warn("updateError", e);
            ACTION_BUILDER.showMessageDialog(parentComponent, "updateError", e);
        }
    }

    @NotNull
    // The stream is closed by caller
    private InputStream openStream(@NotNull final String url) throws IOException {
        final Proxy proxy = NetPreferences.getProxy();
        final URLConnection con = new URL(url).openConnection(proxy);
        final ProgressMonitorInputStream stream = new ProgressMonitorInputStream(parentComponent, ActionBuilderUtils.getString(ACTION_BUILDER, "updateProgress.title"), con.getInputStream());
        final ProgressMonitor monitor = stream.getProgressMonitor();
        monitor.setMaximum(con.getContentLength());
        monitor.setNote(ActionBuilderUtils.getString(ACTION_BUILDER, "updateProgress"));
        monitor.setMillisToDecideToPopup(10);
        monitor.setMillisToPopup(10);
        return stream;
    }

    private static class VersionInfo {

        @NotNull
        private final String version;

        @NotNull
        private final String timestamp;

        @NotNull
        private final String developer;

        @NotNull
        private static final VersionInfo UNAVAILABLE = new VersionInfo();

        private VersionInfo() {
            this("unavailable", "unavailable", "unavailable");
        }

        private VersionInfo(@NotNull final String version, @NotNull final String timestamp, @NotNull final String developer) {
            this.version = version;
            this.timestamp = timestamp;
            this.developer = developer;
        }

        private VersionInfo(@NotNull final ResourceBundle bundle, @NotNull final String prefix) {
            this(bundle.getString(prefix + ".number"), bundle.getString(prefix + ".tstamp"), bundle.getString(prefix + ".developer"));
        }

        @SuppressWarnings("ObjectEquality")
        boolean isNewerThan(@NotNull final VersionInfo other) {
            return this != UNAVAILABLE && (other == UNAVAILABLE || timestamp.compareTo(other.timestamp) > 0);
        }

    }

}