Enable checking for and notifying of new snapshot builds, with option

Mumfrey
1 parent 1f070732
Showing 9 changed files with 185 additions and 27 deletions
src/client/java/com/mumfrey/liteloader/client/LiteLoaderPanelManager.java
src/client/java/com/mumfrey/liteloader/client/gui/GuiLiteLoaderPanel.java
src/client/java/com/mumfrey/liteloader/client/gui/GuiPanelSettings.java
src/main/java/com/mumfrey/liteloader/core/LiteLoader.java
src/main/java/com/mumfrey/liteloader/core/LiteLoaderUpdateSite.java
src/main/java/com/mumfrey/liteloader/interfaces/PanelManager.java
src/main/java/com/mumfrey/liteloader/launch/LoaderProperties.java
src/main/java/com/mumfrey/liteloader/update/UpdateSite.java
src/main/resources/assets/liteloader/lang/en_us.lang
@@ -9,6 +9,7 @@ import org.lwjgl.input.Keyboard;
 import com.mumfrey.liteloader.client.gui.GuiLiteLoaderPanel;
 import com.mumfrey.liteloader.common.GameEngine;
+import com.mumfrey.liteloader.core.LiteLoader;
 import com.mumfrey.liteloader.core.LiteLoaderMods;
 import com.mumfrey.liteloader.core.LiteLoaderUpdateSite;
 import com.mumfrey.liteloader.core.LiteLoaderVersion;
@@ -32,6 +33,13 @@ import net.minecraft.client.resources.I18n;
  */
 public class LiteLoaderPanelManager implements PanelManager<GuiScreen>
 {
+    /**
+     * Number of launches required before an update check is forced when the
+     * "force update check" option is enabled. For snapshot versions this is
+     * ignored and an update check is always performed.
+     */
+    private static final int UPDATE_CHECK_INTERVAL = 10;
+
     private final LoaderEnvironment environment;
     /**
@@ -87,14 +95,14 @@ public class LiteLoaderPanelManager implements PanelManager&lt;GuiScreen&gt;
         this.displayModInfoScreenTab = this.properties.getAndStoreBooleanProperty(LoaderProperties.OPTION_MOD_INFO_SCREEN, true);
         this.tabAlwaysExpanded = this.properties.getAndStoreBooleanProperty(LoaderProperties.OPTION_NO_HIDE_TAB, false);
-        if (this.properties.getAndStoreBooleanProperty(LoaderProperties.OPTION_FORCE_UPDATE, false))
+        if (this.shouldCheckForUpdates())
         {
             int updateCheckInterval = this.properties.getIntegerProperty(LoaderProperties.OPTION_UPDATE_CHECK_INTR) + 1;
-            LiteLoaderLogger.debug("Force update is TRUE, updateCheckInterval = %d", updateCheckInterval);
+            LiteLoaderLogger.debug("Regular update check enabled, updateCheckInterval = %d", updateCheckInterval);
-            if (updateCheckInterval > 10)
+            if (LiteLoader.isSnapshot() || updateCheckInterval > LiteLoaderPanelManager.UPDATE_CHECK_INTERVAL)
             {
-                LiteLoaderLogger.debug("Forcing update check!");
+                LiteLoaderLogger.debug("Checking for updates...");
                 this.checkForUpdate = true;
                 updateCheckInterval = 0;
             }
@@ -104,6 +112,16 @@ public class LiteLoaderPanelManager implements PanelManager&lt;GuiScreen&gt;
         }
     }
+    private boolean shouldCheckForUpdates()
+    {
+        if (LiteLoader.isSnapshot() && this.properties.getAndStoreBooleanProperty(LoaderProperties.OPTION_CHECK_SNAPSHOTS, true))
+        {
+            return true;
+        }
+        
+        return this.properties.getAndStoreBooleanProperty(LoaderProperties.OPTION_FORCE_UPDATE, false);
+    }
+
     @Override
     public void init(LiteLoaderMods mods, ConfigManager configManager)
     {
@@ -141,7 +159,8 @@ public class LiteLoaderPanelManager implements PanelManager&lt;GuiScreen&gt;
                 this.checkForUpdate = false;
                 if (updateSite.isCheckSucceess() && updateSite.isUpdateAvailable())
                 {
-                    this.setNotification(I18n.format("gui.notifications.updateavailable"));
+                    this.setNotification(I18n.format("gui.notifications." + (LiteLoader.isSnapshot() ? "newsnapshotavailable" : "updateavailable"), 
+                        updateSite.getAvailableVersion(), updateSite.getAvailableVersionDate()));
                 }
             }
         }
@@ -251,6 +270,19 @@ public class LiteLoaderPanelManager implements PanelManager&lt;GuiScreen&gt;
     {
         return this.properties.getBooleanProperty(LoaderProperties.OPTION_FORCE_UPDATE);
     }
+    
+    @Override
+    public void setCheckForSnapshotsEnabled(boolean checkForSnapshots)
+    {
+        this.properties.setBooleanProperty(LoaderProperties.OPTION_CHECK_SNAPSHOTS, checkForSnapshots);
+        this.properties.writeProperties();
+    }
+    
+    @Override
+    public boolean isCheckForSnapshotsEnabled()
+    {
+        return this.properties.getBooleanProperty(LoaderProperties.OPTION_CHECK_SNAPSHOTS);
+    }
     /**
      * Display the liteloader panel over the specified GUI
@@ -177,11 +177,10 @@ public class GuiLiteLoaderPanel extends GuiScreen
         this.startupErrorCount = mods.getStartupErrorCount();
         this.criticalErrorCount = mods.getCriticalErrorCount();
-        String branding = LiteLoader.getBranding();
-        if (branding != null && branding.contains("SNAPSHOT"))
+        this.isSnapshot = LiteLoader.isSnapshot();
+        if (this.isSnapshot)
         {
-            this.isSnapshot = true;
-            this.versionText = "\247c" + branding;
+            this.versionText = "\247c" + LiteLoader.getBranding();
         }
     }
@@ -524,6 +523,7 @@ public class GuiLiteLoaderPanel extends GuiScreen
             if (annoyingTip)
             {
+                GuiLiteLoaderPanel.displayErrorToolTip = false;
                 this.drawNotificationTooltip(mouseX, mouseY - 13);
             }
         }
@@ -542,8 +542,11 @@ public class GuiLiteLoaderPanel extends GuiScreen
         }
         else if (this.notification != null)
         {
-            GuiLiteLoaderPanel.drawTooltip(this.fontRenderer, this.notification, left, top, this.width, this.height,
-                    GuiLiteLoaderPanel.NOTIFICATION_TOOLTIP_FOREGROUND, GuiLiteLoaderPanel.NOTIFICATION_TOOLTIP_BACKGROUND);
+            boolean isCritical = this.notification.startsWith("!!");
+            String text = isCritical ? this.notification.substring(2) : this.notification;
+            int bgColour = isCritical ? GuiLiteLoaderPanel.ERROR_TOOLTIP_BACKGROUND : GuiLiteLoaderPanel.NOTIFICATION_TOOLTIP_BACKGROUND;
+            GuiLiteLoaderPanel.drawTooltip(this.fontRenderer, text, left, top, this.width, this.height,
+                    GuiLiteLoaderPanel.NOTIFICATION_TOOLTIP_FOREGROUND, bgColour);
         }
     }
@@ -739,21 +742,32 @@ public class GuiLiteLoaderPanel extends GuiScreen
      * 
      * @param fontRenderer
      * @param tooltipText
-     * @param mouseX
-     * @param mouseY
+     * @param left
+     * @param top
      * @param screenWidth
      * @param screenHeight
      * @param colour
      * @param backgroundColour
      */
-    public static void drawTooltip(FontRenderer fontRenderer, String tooltipText, int mouseX, int mouseY, int screenWidth, int screenHeight,
+    public static void drawTooltip(FontRenderer fontRenderer, String text, int left, int top, int screenWidth, int screenHeight,
             int colour, int backgroundColour)
     {
-        int textSize = fontRenderer.getStringWidth(tooltipText);
-        mouseX = Math.max(0, Math.min(screenWidth - 4, mouseX - 4));
-        mouseY = Math.max(0, Math.min(screenHeight - 16, mouseY));
-        drawRect(mouseX - textSize - 2, mouseY, mouseX + 2, mouseY + 12, backgroundColour);
-        fontRenderer.drawStringWithShadow(tooltipText, mouseX - textSize, mouseY + 2, colour);
+        String[] lines = text.trim().split("\\r?\\n");
+        int textWidth = 0;
+        int textHeight = 9 * lines.length;
+        for (String line : lines)
+        {
+            textWidth = Math.max(textWidth, fontRenderer.getStringWidth(line));
+            top -= 9;
+        }
+        
+        left = Math.max(0, Math.min(screenWidth - 4, left - 4));
+        top = Math.max(0, Math.min(screenHeight - 16, top + 9));
+        drawRect(left - textWidth - 2, top, left + 2, top + textHeight + 2, backgroundColour);
+        for (String line : lines)
+        {
+            fontRenderer.drawStringWithShadow(line, left - textWidth, (top += 9) - 7, colour);
+        }
     }
@@ -17,25 +17,29 @@ import net.minecraft.client.resources.I18n;
 class GuiPanelSettings extends GuiPanel
 {
-    private GuiLiteLoaderPanel parentScreen;
+    private final GuiLiteLoaderPanel parentScreen;
+    
+    private final boolean isSnapshot;
-    private GuiCheckbox chkShowTab, chkNoHide, chkForceUpdate;
+    private GuiCheckbox chkShowTab, chkNoHide, chkForceUpdate, chkCheckForSnapshots;
     private boolean hide;
     private String[] helpText = new String[5];
-
+    
     GuiPanelSettings(GuiLiteLoaderPanel parentScreen, Minecraft minecraft)
     {
         super(minecraft);
         this.parentScreen = parentScreen;
+        this.isSnapshot = LiteLoader.isSnapshot();
+        String helpKey = this.isSnapshot ? "checkforsnapshots" : "forceupdate"; 
         this.helpText[0] = I18n.format("gui.settings.showtab.help1");
         this.helpText[1] = I18n.format("gui.settings.showtab.help2");
         this.helpText[2] = I18n.format("gui.settings.notabhide.help1");
-        this.helpText[3] = I18n.format("gui.settings.forceupdate.help1");
-        this.helpText[4] = I18n.format("gui.settings.forceupdate.help2");
+        this.helpText[3] = I18n.format("gui.settings." + helpKey + ".help1");
+        this.helpText[4] = I18n.format("gui.settings." + helpKey + ".help2");
     }
     @Override
@@ -61,6 +65,10 @@ class GuiPanelSettings extends GuiPanel
         this.controls.add(this.chkShowTab = new GuiCheckbox(0, 34, 90, I18n.format("gui.settings.showtab.label")));
         this.controls.add(this.chkNoHide = new GuiCheckbox(1, 34, 128, I18n.format("gui.settings.notabhide.label")));
         this.controls.add(this.chkForceUpdate = new GuiCheckbox(2, 34, 158, I18n.format("gui.settings.forceupdate.label")));
+        this.controls.add(this.chkCheckForSnapshots = new GuiCheckbox(2, 34, 158, I18n.format("gui.settings.checkforsnapshots.label")));
+        
+        this.chkForceUpdate.visible = !this.isSnapshot;
+        this.chkCheckForSnapshots.visible = this.isSnapshot;
         this.updateCheckBoxes();
     }
@@ -72,6 +80,7 @@ class GuiPanelSettings extends GuiPanel
         this.chkShowTab.checked = panelManager.isTabVisible();
         this.chkNoHide.checked = panelManager.isTabAlwaysExpanded();
         this.chkForceUpdate.checked = panelManager.isForceUpdateEnabled();
+        this.chkCheckForSnapshots.checked = panelManager.isCheckForSnapshotsEnabled();
     }
     private void updateSettings()
@@ -81,6 +90,7 @@ class GuiPanelSettings extends GuiPanel
         panelManager.setTabVisible(this.chkShowTab.checked);
         panelManager.setTabAlwaysExpanded(this.chkNoHide.checked);
         panelManager.setForceUpdateEnabled(this.chkForceUpdate.checked);
+        panelManager.setCheckForSnapshotsEnabled(this.chkCheckForSnapshots.checked);
     }
     @Override
@@ -532,6 +532,15 @@ public final class LiteLoader
     {
         return "true".equals(System.getProperty("mcpenv"));
     }
+    
+    /**
+     * Get whether the current running version is a snapshot build
+     */
+    public static boolean isSnapshot()
+    {
+        String branding = LiteLoader.getBranding();
+        return branding != null && branding.contains("SNAPSHOT"); 
+    }
     /**
      * Dump debugging information to the console
@@ -8,6 +8,10 @@ package com.mumfrey.liteloader.core;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.Date;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import com.google.common.io.ByteSink;
 import com.google.common.io.Files;
@@ -21,6 +25,8 @@ public class LiteLoaderUpdateSite extends UpdateSite
     private static final String UPDATE_SITE_URL = "http://dl.liteloader.com/versions/";
     private static final String UPDATE_SITE_VERSIONS_JSON = "versions.json";
     private static final String UPDATE_SITE_ARTEFACT_NAME = "com.mumfrey:liteloader";
+    
+    private static final Pattern SNAPSHOT_REGEX = Pattern.compile("^([0-9\\._]+)-SNAPSHOT-(r[0-9a-z]+)-(b([0-9]+))-(.*)$", Pattern.CASE_INSENSITIVE);
     private String mcVersion;
@@ -28,6 +34,10 @@ public class LiteLoaderUpdateSite extends UpdateSite
     private File jarFile = null;
     private boolean updateForced = false;
+    private boolean isSnapshot = false;
+    
+    private int currentBuild, availableBuild;
+    private String snapshotDate = null;
     public LiteLoaderUpdateSite(String targetVersion, long currentTimeStamp)
     {
@@ -36,6 +46,64 @@ public class LiteLoaderUpdateSite extends UpdateSite
         this.mcVersion = targetVersion; 
     }
+    
+    @Override
+    public void beginUpdateCheck()
+    {
+        this.isSnapshot = LiteLoader.isSnapshot();
+        super.beginUpdateCheck();
+    }
+    
+    @Override
+    public boolean isSnapshot()
+    {
+        return this.isSnapshot;
+    }
+    
+    @Override
+    public String getAvailableVersion()
+    {
+        if (this.isSnapshot() && this.availableBuild > 0)
+        {
+            return String.valueOf(this.availableBuild);
+        }
+        
+        return super.getAvailableVersion();
+    }
+    
+    @Override
+    public String getAvailableVersionDate()
+    {
+        if (this.snapshotDate != null)
+        {
+            return this.snapshotDate;
+        }
+        
+        return super.getAvailableVersionDate();
+    }
+    
+    @Override
+    protected boolean compareArtefact(Map<?, ?> artefact, long bestTimeStamp, Long remoteTimeStamp)
+    {
+        if (this.isSnapshot())
+        {
+            String remoteBuild = artefact.get("build").toString();
+            String myBuild = LiteLoader.getBranding();
+            
+            Matcher remoteMatcher = LiteLoaderUpdateSite.SNAPSHOT_REGEX.matcher(remoteBuild);
+            Matcher myMatcher = LiteLoaderUpdateSite.SNAPSHOT_REGEX.matcher(myBuild);
+            
+            if (remoteMatcher.matches() && myMatcher.matches())
+            {
+                this.currentBuild = Integer.parseInt(myMatcher.group(4));
+                this.availableBuild = Integer.parseInt(remoteMatcher.group(4));
+                this.snapshotDate = String.format("%1$tY-%1$tm-%1$td %1$tH:%1$tM", new Date(remoteTimeStamp * 1000L));
+                return this.availableBuild > this.currentBuild;
+            }
+        }
+        
+        return super.compareArtefact(artefact, bestTimeStamp, remoteTimeStamp);
+    }
     public boolean canForceUpdate(LoaderProperties properties)
     {
@@ -88,4 +88,14 @@ public interface PanelManager&lt;TParentScreen&gt; extends TickObserver, PostRenderObs
      * Get whether "force update" is enabled
      */
     public abstract boolean isForceUpdateEnabled();
+
+    /**
+     * Set whether "check for new snapshots" is enabled
+     */
+    public abstract void setCheckForSnapshotsEnabled(boolean checkForSnapshots);
+
+    /**
+     * Get whether "check for new snapshots" is enabled
+     */
+    public abstract boolean isCheckForSnapshotsEnabled();
 }
@@ -99,6 +99,7 @@ public interface LoaderProperties
     public static final String OPTION_FORCE_UPDATE      = "allowForceUpdate";
     public static final String OPTION_UPDATE_CHECK_INTR = "updateCheckInterval";
     public static final String OPTION_JINPUT_DISABLE    = "disableJInput";
+    public static final String OPTION_CHECK_SNAPSHOTS   = "checkForNewSnapshots";
     // Enumerator properties
     public static final String OPTION_SEARCH_MODS       = "search.mods";
@@ -160,6 +160,11 @@ public class UpdateSite implements Comparator&lt;Long&gt;
             }
         }
     }
+    
+    public boolean isSnapshot()
+    {
+        return false;
+    }
     /**
      * Gets whether a check is in progress
@@ -319,7 +324,7 @@ public class UpdateSite implements Comparator&lt;Long&gt;
      */
     private void handleVersionData(Object key, Map<?, ?> value)
     {
-        if ("artefacts".equals(key))
+        if ((this.isSnapshot() && "snapshots".equals(key)) || (!this.isSnapshot() && "artefacts".equals(key)))
         {
             if (value.containsKey(this.artefact))
             {
@@ -387,7 +392,7 @@ public class UpdateSite implements Comparator&lt;Long&gt;
             this.availableVersion = artefact.get("version").toString();
             this.availableVersionDate = DateFormat.getDateTimeInstance().format(new Date(remoteTimeStamp * 1000L));
             this.availableVersionURL = this.createArtefactURL(artefact.get("file").toString());
-            this.updateAvailable = this.compareTimeStamps(bestTimeStamp, remoteTimeStamp);
+            this.updateAvailable = this.compareArtefact(artefact, bestTimeStamp, remoteTimeStamp);
             return true;
         }
@@ -395,6 +400,11 @@ public class UpdateSite implements Comparator&lt;Long&gt;
         return false;
     }
+    protected boolean compareArtefact(Map<?, ?> artefact, long bestTimeStamp, Long remoteTimeStamp)
+    {
+        return this.compareTimeStamps(bestTimeStamp, remoteTimeStamp);
+    }
+
     /**
      * @param bestTimeStamp
      * @param remoteTimeStamp
@@ -16,6 +16,9 @@ gui.settings.notabhide.help1=Only applies if the above option is also checked
 gui.settings.forceupdate.label=Periodically Check For Updates
 gui.settings.forceupdate.help1=This option is §cexperimental§r and may not work properly 
 gui.settings.forceupdate.help2=yet, it also enables the "force update" capability. 
+gui.settings.checkforsnapshots.label=Check For New Snapshots
+gui.settings.checkforsnapshots.help1=If this option is enabled, LiteLoader will check
+gui.settings.checkforsnapshots.help2=for new SNAPSHOT releases each time it it launched
 gui.about.taboptions=§nLiteLoader Panel Options
@@ -86,4 +89,5 @@ gui.error.title=Startup errors for %s
 gui.error.tooltip=%d mod startup error(s) detected (%d critical)
-gui.notifications.updateavailable=LiteLoader Update Available!
 \ No newline at end of file
+gui.notifications.updateavailable=LiteLoader Update Available!
+gui.notifications.newsnapshotavailable=!!New Snapshot Available:%nBuild #%s (%s)
 \ No newline at end of file