Merge pull request #99 from tiwiz/autoupdate

Autoupdate

Author: borisf

ClassySharkWS/src/com/google/classyshark/Version.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark;
+
+/**
+ * This file is the one containg the data for the current ClassyShark version
+ */
+public class Version {
+
+    public static final int MAJOR = 1;
+    public static final int MINOR = 0;
+}

ClassySharkWS/src/com/google/classyshark/cli/CliMode.java

@@ -16,6 +16,8 @@
 
 package com.google.classyshark.cli;
 
+import com.google.classyshark.updater.UpdateManager;
+
 import java.io.File;
 import java.util.List;
 
@@ -42,6 +44,7 @@ private CliMode() {
     }
 
     public static void with(List<String> args) {
+        UpdateManager.getInstance().checkVersionConsole();
         if (args.size() < 2) {
             System.err.println("missing command line arguments " + "\n\n\n" + ERROR_MESSAGE);
             return;

ClassySharkWS/src/com/google/classyshark/gui/GuiMode.java

@@ -19,6 +19,7 @@
 import com.google.classyshark.gui.panel.ClassySharkPanel;
 import com.google.classyshark.gui.theme.Theme;
 import com.google.classyshark.gui.theme.ThemeManager;
+import com.google.classyshark.updater.UpdateManager;
 
 import javax.swing.JFrame;
 import javax.swing.UIManager;
@@ -38,6 +39,7 @@ private GuiMode() {
     }
 
     public static void with(final List<String> argsAsArray) {
+        UpdateManager.getInstance().checkVersionGui();
         javax.swing.SwingUtilities.invokeLater(new Runnable() {
             public void run() {
                 buildAndShowClassyShark(argsAsArray);

ClassySharkWS/src/com/google/classyshark/updater/UpdateManager.java

@@ -0,0 +1,89 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark.updater;
+
+import com.google.classyshark.updater.models.Release;
+import com.google.classyshark.updater.networking.AbstractReleaseCallback;
+import com.google.classyshark.updater.networking.MessageRunnable;
+import com.google.classyshark.updater.networking.NetworkManager;
+import com.google.classyshark.updater.utils.FileUtils;
+import retrofit2.Call;
+
+import javax.swing.*;
+import java.io.IOException;
+
+
+/**
+ * This class is the core point for the update process: based on the response received from GitHub, it will download
+ * the new release and, if ClassyShark has been started as desktop app, when the download finishes, it will show a
+ * dialog containing the changelog of the new version
+ */
+public class UpdateManager{
+    private static final UpdateManager instance = new UpdateManager();
+    private final AbstractReleaseCallback releaseCallback;
+    private final Release currentRelease = new Release();
+    private boolean isGui = false;
+
+    private UpdateManager() {
+        releaseCallback = new AbstractReleaseCallback() {
+            @Override
+            public void onReleaseReceived(Release release) {
+                onReleaseResponse(release);
+            }
+        };
+    }
+
+    public static UpdateManager getInstance() {
+        return instance;
+    }
+
+    public void checkVersionConsole() {
+        checkVersion(false);
+    }
+
+    public void checkVersionGui() {
+        checkVersion(true);
+    }
+
+    private void checkVersion(boolean isGui) {
+        this.isGui = isGui;
+        Call<Release> call = NetworkManager.getGitHubApi().getLatestRelease();
+        call.enqueue(releaseCallback);
+    }
+
+    private void onReleaseResponse(Release release) {
+        if (release.isNewerThan(currentRelease)) {
+            new Thread(new Runnable() {
+                @Override
+                public void run() {
+                    obtainNew(release);
+                    SwingUtilities.invokeLater(new MessageRunnable(release.getReleaseName(), release.getChangelog(), isGui));
+                }
+            }).start();
+
+        }
+    }
+
+    private void obtainNew(Release release) {
+        try {
+            FileUtils.downloadFileFrom(release);
+        } catch (IOException e) {
+            System.err.println("ERROR: " + e.getMessage());
+        }
+    }
+
+}

ClassySharkWS/src/com/google/classyshark/updater/models/Release.java

@@ -0,0 +1,115 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark.updater.models;
+
+
+import com.google.classyshark.Version;
+import com.google.classyshark.updater.networking.GitHubApi;
+import com.google.gson.annotations.SerializedName;
+import com.sun.istack.internal.Nullable;
+
+/**
+ * This class represents the response that GitHub returns when queried with {@link GitHubApi#getLatestRelease()}.
+ * Since we do not need all the fields from the response, we just add those we are gonna use.
+ * At the moment, the {@link #preRelease} field is not used, but it will most probably be in the future in case we want to
+ * only update to stable releases.
+ */
+public class Release {
+
+    private final String name;
+    @SerializedName("prerelease")
+    private final boolean preRelease;
+    private final String body;
+    private final ReleaseDownloadData[] assets;
+    @SerializedName("created_at")
+    private final String createdAt;
+
+
+    private Release(String name, boolean preRelease, String body, ReleaseDownloadData[] assets, String createdAt) {
+        this.name = name;
+        this.preRelease = preRelease;
+        this.body = body;
+        this.assets = assets;
+        this.createdAt = createdAt;
+    }
+
+    public Release() {
+        this(String.format("%d.%d", Version.MAJOR, Version.MINOR), false, "", null, "");
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if (!(other instanceof Release)) {
+            return false;
+        }
+
+        return name.equals(((Release) other).name);
+    }
+
+    private int getMajorVersion() {
+        return getVersionField(0);
+    }
+
+    private int getVersionField(int field) {
+        String cleanedReleaseName = name.split("\\s")[0];
+        return Integer.parseInt(cleanedReleaseName.split("\\.")[field]);
+    }
+
+    private int getMinorVersion() {
+        return getVersionField(1);
+    }
+
+    @Override
+    public int hashCode() {
+        return name.hashCode();
+    }
+
+    @Override
+    public String toString() {
+        return "REL:\t" + name + "\nCHANGELOG:\n" + body;
+    }
+
+    public boolean isNewerThan(Release other) {
+        return getMajorVersion() > other.getMajorVersion() ||
+                getMajorVersion() == other.getMajorVersion() && getMinorVersion() > other.getMinorVersion();
+    }
+
+    @Nullable
+    public String getDownloadURL() {
+        if (assets != null && assets.length > 0) {
+            return assets[0].getURL();
+        } else {
+            return null;
+        }
+    }
+
+    public String getReleaseName() {
+        return name;
+    }
+
+    public boolean isPreRelease() {
+        return preRelease;
+    }
+
+    public String getChangelog() {
+        return body;
+    }
+
+    public String getCreatedAt() {
+        return createdAt;
+    }
+}

ClassySharkWS/src/com/google/classyshark/updater/models/ReleaseDownloadData.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark.updater.models;
+
+import com.google.gson.annotations.SerializedName;
+
+class ReleaseDownloadData {
+
+    @SerializedName("browser_download_url")
+    private final String browserDownloadUrl;
+
+    ReleaseDownloadData(String browserDownloadUrl) {
+        this.browserDownloadUrl = browserDownloadUrl;
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if (!(other instanceof ReleaseDownloadData)) {
+            return false;
+        }
+
+        return browserDownloadUrl.equals(((ReleaseDownloadData) other).browserDownloadUrl);
+    }
+
+    @Override
+    public int hashCode() {
+        return browserDownloadUrl.hashCode();
+    }
+
+    String getURL() {
+        return browserDownloadUrl;
+    }
+}

ClassySharkWS/src/com/google/classyshark/updater/networking/AbstractReleaseCallback.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark.updater.networking;
+
+import com.google.classyshark.updater.models.Release;
+import retrofit2.Call;
+import retrofit2.Callback;
+import retrofit2.Response;
+
+public abstract class AbstractReleaseCallback implements Callback<Release>{
+
+    @Override
+    public void onResponse(Call<Release> call, Response<Release> response) {
+        onReleaseReceived(response.body());
+    }
+
+    public abstract void onReleaseReceived(Release release);
+
+    @Override
+    public void onFailure(Call<Release> call, Throwable throwable) {
+        System.err.println("ERROR: " + throwable.getMessage());
+    }
+}

ClassySharkWS/src/com/google/classyshark/updater/networking/GitHubApi.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark.updater.networking;
+
+
+import com.google.classyshark.updater.models.Release;
+import retrofit2.Call;
+import retrofit2.http.GET;
+
+/**
+ * This class is the one taking care of representing the API needed in order to retrieve the latest release data from
+ * GitHub.
+ */
+public interface GitHubApi {
+
+    String ENDPOINT = "https://api.github.com/";
+
+    @GET("repos/google/android-classyshark/releases/latest")
+    Call<Release> getLatestRelease();
+}