From fde0619e9bc06492d1096273723e8f32ab73cfe0 Mon Sep 17 00:00:00 2001 From: Christian Date: Fri, 10 Aug 2012 23:17:31 -0400 Subject: [PATCH] New downloader UI and new downloader backend - should be more robust now --- .../cpw/mods/fml/relauncher/Downloader.java | 154 ++++++++++++++ .../mods/fml/relauncher/FMLRelauncher.java | 23 +-- .../relauncher/RelaunchLibraryManager.java | 188 ++++++++++++------ 3 files changed, 287 insertions(+), 78 deletions(-) create mode 100644 fml/common/cpw/mods/fml/relauncher/Downloader.java diff --git a/fml/common/cpw/mods/fml/relauncher/Downloader.java b/fml/common/cpw/mods/fml/relauncher/Downloader.java new file mode 100644 index 0000000000..6b796a40c5 --- /dev/null +++ b/fml/common/cpw/mods/fml/relauncher/Downloader.java @@ -0,0 +1,154 @@ +package cpw.mods.fml.relauncher; + +import java.awt.BorderLayout; +import java.awt.Color; +import java.awt.Component; +import java.awt.Container; +import java.awt.Dialog.ModalityType; +import java.awt.Dimension; +import java.awt.FlowLayout; +import java.awt.event.WindowAdapter; +import java.awt.event.WindowEvent; +import java.awt.event.WindowListener; +import java.beans.PropertyChangeEvent; +import java.beans.PropertyChangeListener; +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.nio.ByteBuffer; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; + +import javax.swing.AbstractButton; +import javax.swing.BorderFactory; +import javax.swing.Box; +import javax.swing.JButton; +import javax.swing.JDialog; +import javax.swing.JFrame; +import javax.swing.JLabel; +import javax.swing.JOptionPane; +import javax.swing.JPanel; +import javax.swing.JProgressBar; +import javax.swing.JRootPane; +import javax.swing.JWindow; + +import cpw.mods.fml.common.FMLLog; + +public class Downloader extends JOptionPane +{ + private static Downloader instance; + private JDialog container; + private JLabel currentActivity; + private JProgressBar progress; + + public Downloader() + { + super(); + instance = this; + setMessageType(JOptionPane.INFORMATION_MESSAGE); + setMessage(makeProgressPanel()); + setOptions(new Object[] { "Stop" }); + addPropertyChangeListener(new PropertyChangeListener() + { + @Override + public void propertyChange(PropertyChangeEvent evt) + { + if (evt.getSource() == instance && evt.getPropertyName()==VALUE_PROPERTY) + { + requestClose("This will stop minecraft from launching\nAre you sure you want to do this?"); + } + } + }); + } + + private Box makeProgressPanel() + { + Box box = Box.createVerticalBox(); + box.add(Box.createRigidArea(new Dimension(0,10))); + JLabel welcomeLabel = new JLabel("FML is setting up your minecraft environment"); + box.add(welcomeLabel); + welcomeLabel.setAlignmentY(LEFT_ALIGNMENT); + welcomeLabel = new JLabel("Please wait, FML has some tasks to do before you can play"); + welcomeLabel.setAlignmentY(LEFT_ALIGNMENT); + box.add(welcomeLabel); + box.add(Box.createRigidArea(new Dimension(0,10))); + currentActivity = new JLabel("Currently doing ..."); + box.add(currentActivity); + box.add(Box.createRigidArea(new Dimension(0,10))); + progress = new JProgressBar(0, 100); + progress.setStringPainted(true); + box.add(progress); + box.add(Box.createRigidArea(new Dimension(0,30))); + return box; + } + + public static void main(String[] args) + { + instance = new Downloader(); + instance.makeDialog(); + } + + JDialog makeDialog() + { + container = new JDialog(null, "Hello", ModalityType.MODELESS); + container.setResizable(false); + container.setLocationRelativeTo(null); + container.add(instance); + instance.updateUI(); + container.pack(); + container.setMinimumSize(container.getPreferredSize()); + container.setVisible(true); + container.setDefaultCloseOperation(JFrame.DO_NOTHING_ON_CLOSE); + container.addWindowListener(new WindowAdapter() + { + @Override + public void windowClosing(WindowEvent e) + { + instance.requestClose("Closing this window will stop minecraft from launching\nAre you sure you wish to do this?"); + } + }); + return container; + } + protected void requestClose(String message) + { + int shouldClose = JOptionPane.showConfirmDialog(container, message, "Are you sure you want to stop?", JOptionPane.YES_NO_OPTION, JOptionPane.WARNING_MESSAGE); + if (shouldClose == JOptionPane.YES_OPTION) + { + container.dispose(); + } + } + + void updateProgressString(String progressUpdate, Object... data) + { + FMLLog.finest(progressUpdate, data); + if (currentActivity!=null) + { + currentActivity.setText(String.format(progressUpdate,data)); + } + } + + void resetProgress(int sizeGuess) + { + if (progress!=null) + { + progress.getModel().setRangeProperties(0, 0, 0, sizeGuess, false); + } + } + + void updateProgress(int fullLength) + { + if (progress!=null) + { + progress.getModel().setValue(fullLength); + } + } + + static void makeHeadless() + { + instance.container = null; + instance.progress = null; + instance.currentActivity = null; + } + +} diff --git a/fml/common/cpw/mods/fml/relauncher/FMLRelauncher.java b/fml/common/cpw/mods/fml/relauncher/FMLRelauncher.java index 4a3f8a7207..17461bb8f4 100644 --- a/fml/common/cpw/mods/fml/relauncher/FMLRelauncher.java +++ b/fml/common/cpw/mods/fml/relauncher/FMLRelauncher.java @@ -67,15 +67,12 @@ public class FMLRelauncher { try { - popupWindow = new JDialog(null, "FML Initial Setup", ModalityType.MODELESS); - JOptionPane optPane = new JOptionPane("FML Setup

FML is performing some configuration, please wait", JOptionPane.INFORMATION_MESSAGE, JOptionPane.DEFAULT_OPTION, null, new Object[0]); - popupWindow.add(optPane); - popupWindow.pack(); - popupWindow.setLocationRelativeTo(null); - popupWindow.setVisible(true); + RelaunchLibraryManager.downloadMonitor = new Downloader(); + popupWindow = RelaunchLibraryManager.downloadMonitor.makeDialog(); } catch (Exception e) { + Downloader.makeHeadless(); popupWindow = null; } } @@ -147,7 +144,7 @@ public class FMLRelauncher { try { - String logFile = new File(minecraftHome,"ForgeModLoader-0.log").getCanonicalPath(); + String logFile = new File(minecraftHome,"ForgeModLoader-client-0.log").getCanonicalPath(); JOptionPane.showMessageDialog(popupWindow, String.format("
There was a fatal error starting up minecraft and FML

" + "Minecraft cannot launch in it's current configuration
" + @@ -267,18 +264,6 @@ public class FMLRelauncher return; } - public InputStream wrapStream(InputStream inputStream, String infoString) - { - if (popupWindow!=null) - { - return new ProgressMonitorInputStream(popupWindow, infoString, inputStream); - } - else - { - return inputStream; - } - } - public static String side() { return side; diff --git a/fml/common/cpw/mods/fml/relauncher/RelaunchLibraryManager.java b/fml/common/cpw/mods/fml/relauncher/RelaunchLibraryManager.java index 39b8ec2980..295bfabac2 100644 --- a/fml/common/cpw/mods/fml/relauncher/RelaunchLibraryManager.java +++ b/fml/common/cpw/mods/fml/relauncher/RelaunchLibraryManager.java @@ -41,7 +41,6 @@ import cpw.mods.fml.common.discovery.ModCandidate; public class RelaunchLibraryManager { private static String[] rootPlugins = { "cpw.mods.fml.relauncher.FMLCorePlugin" , "net.minecraftforge.classloading.FMLForgePlugin" }; - private static final String HEXES = "0123456789abcdef"; private static List loadedLibraries = new ArrayList(); private static Map pluginLocations; private static List loadPlugins; @@ -73,6 +72,7 @@ public class RelaunchLibraryManager throw new RuntimeException("A fatal error has occured - no valid fml load plugin was found - this is a completely corrupt FML installation."); } + downloadMonitor.updateProgressString("All core mods are successfully located"); // Now that we have the root plugins loaded - lets see what else might be around discoverCoreMods(mcDir, actualClassLoader, loadPlugins, libraries); @@ -102,7 +102,7 @@ public class RelaunchLibraryManager { try { - downloadFile(libFile, lib.getRootURL()); + downloadFile(libFile, lib.getRootURL(), checksum); download = true; } catch (Throwable e) @@ -118,28 +118,37 @@ public class RelaunchLibraryManager continue; } - String fileChecksum = generateChecksum(libFile); - // bad checksum and I did not download this file - if (!checksum.equals(fileChecksum) && !download) + if (!download) { - caughtErrors.add(new RuntimeException(String.format("The file %s was found in your lib directory and has an invalid checksum %s (expecting %s) - it is unlikely to be the correct download, please move it out of the way and try again.", libName, fileChecksum, checksum))); - continue; - } - // bad checksum but file was downloaded this session - else if (!checksum.equals(fileChecksum)) - { - caughtErrors.add(new RuntimeException(String.format("The downloaded file %s has an invalid checksum %s (expecting %s). The download did not succeed correctly and the file has been deleted. Please try launching again.", libName, fileChecksum, checksum))); - libFile.delete(); - continue; + try + { + FileInputStream fis = new FileInputStream(libFile); + FileChannel chan = fis.getChannel(); + MappedByteBuffer mappedFile = chan.map(MapMode.READ_ONLY, 0, libFile.length()); + String fileChecksum = generateChecksum(mappedFile); + fis.close(); + // bad checksum and I did not download this file + if (!checksum.equals(fileChecksum)) + { + caughtErrors.add(new RuntimeException(String.format("The file %s was found in your lib directory and has an invalid checksum %s (expecting %s) - it is unlikely to be the correct download, please move it out of the way and try again.", libName, fileChecksum, checksum))); + continue; + } + } + catch (Exception e) + { + FMLRelaunchLog.log(Level.SEVERE, e, "The library file %s could not be validated", libFile.getName()); + caughtErrors.add(new RuntimeException(String.format("The library file %s could not be validated", libFile.getName()),e)); + continue; + } } if (!download) { - System.out.printf("Found library file %s present and correct in lib dir\n", libName); + downloadMonitor.updateProgressString("Found library file %s present and correct in lib dir\n", libName); } else { - System.out.printf("Library file %s was downloaded and verified successfully\n", libName); + downloadMonitor.updateProgressString("Library file %s was downloaded and verified successfully\n", libName); } try @@ -174,7 +183,10 @@ public class RelaunchLibraryManager "They may help you diagnose and resolve the issue"); for (Throwable t : caughtErrors) { - FMLRelaunchLog.severe(t.getMessage()); + if (t.getMessage()!=null) + { + FMLRelaunchLog.severe(t.getMessage()); + } } FMLRelaunchLog.severe("<<< ==== >>>"); FMLRelaunchLog.severe("The following is diagnostic information for developers to review."); @@ -197,11 +209,13 @@ public class RelaunchLibraryManager } } + downloadMonitor.updateProgressString("Running coremod plugins"); Map data = new HashMap(); data.put("mcLocation", mcDir); data.put("coremodList", loadPlugins); for (IFMLLoadingPlugin plugin : loadPlugins) { + downloadMonitor.updateProgressString("Running coremod plugin %s", plugin.getClass().getSimpleName()); data.put("coremodLocation", pluginLocations.get(plugin)); plugin.injectData(data); String setupClass = plugin.getSetupClass(); @@ -220,6 +234,7 @@ public class RelaunchLibraryManager throw new RuntimeException(e); } } + downloadMonitor.updateProgressString("Coremod plugin %s run successfully", plugin.getClass().getSimpleName()); String modContainer = plugin.getModContainerClass(); if (modContainer != null) @@ -229,9 +244,12 @@ public class RelaunchLibraryManager } try { + downloadMonitor.updateProgressString("Validating minecraft"); Class loaderClazz = Class.forName("cpw.mods.fml.common.Loader", true, actualClassLoader); Method m = loaderClazz.getMethod("injectData", Object[].class); m.invoke(null, (Object)FMLInjectionData.data()); + downloadMonitor.updateProgressString("Minecraft validated, launching..."); + downloadBuffer = null; } catch (Exception e) { @@ -244,6 +262,7 @@ public class RelaunchLibraryManager private static void discoverCoreMods(File mcDir, RelaunchClassLoader classLoader, List loadPlugins, List libraries) { + downloadMonitor.updateProgressString("Discovering coremods"); File coreMods = setupCoreModDir(mcDir); FilenameFilter ff = new FilenameFilter() { @@ -258,7 +277,7 @@ public class RelaunchLibraryManager for (File coreMod : coreModList) { - FMLRelaunchLog.fine("Found a candidate coremod %s", coreMod.getName()); + downloadMonitor.updateProgressString("Found a candidate coremod %s", coreMod.getName()); JarFile jar; Attributes mfAttributes; try @@ -307,6 +326,7 @@ public class RelaunchLibraryManager } try { + downloadMonitor.updateProgressString("Loading coremod %s", coreMod.getName()); Class coreModClass = Class.forName(fmlCorePlugin, true, classLoader); IFMLLoadingPlugin plugin = (IFMLLoadingPlugin) coreModClass.newInstance(); loadPlugins.add(plugin); @@ -318,7 +338,7 @@ public class RelaunchLibraryManager libraries.add((ILibrarySet) Class.forName(libName, true, classLoader).newInstance()); } } - FMLRelaunchLog.fine("Loaded coremod %s", coreMod.getName()); + downloadMonitor.updateProgressString("Loaded coremod %s", coreMod.getName()); } catch (ClassNotFoundException cnfe) { @@ -391,17 +411,100 @@ public class RelaunchLibraryManager return coreModDir; } - private static String generateChecksum(File file) + private static void downloadFile(File libFile, String rootUrl, String hash) + { + try + { + URL libDownload = new URL(String.format(rootUrl,libFile.getName())); + String infoString = String.format("Downloading file %s", libDownload.toString()); + downloadMonitor.updateProgressString(infoString); + FMLRelaunchLog.info(infoString); + URLConnection connection = libDownload.openConnection(); + int sizeGuess = connection.getContentLength(); + performDownload(connection.getInputStream(), sizeGuess, hash, libFile); + downloadMonitor.updateProgressString("Download complete"); + FMLRelaunchLog.info("Download complete"); + } + catch (Exception e) + { + if (e instanceof RuntimeException) throw (RuntimeException)e; + FMLRelaunchLog.severe("There was a problem downloading the file %s automatically. Perhaps you" + + "have an environment without internet access. You will need to download " + + "the file manually\n", libFile.getName()); + libFile.delete(); + throw new RuntimeException("A download error occured", e); + } + } + + public static List getLibraries() + { + return loadedLibraries; + } + + private static final String HEXES = "0123456789abcdef"; + private static ByteBuffer downloadBuffer = ByteBuffer.allocateDirect(1 << 22); + static Downloader downloadMonitor; + + private static void performDownload(InputStream is, int sizeGuess, String validationHash, File target) + { + if (sizeGuess > downloadBuffer.capacity()) + { + throw new RuntimeException(String.format("The file %s is too large to be downloaded by FML - the coremod is invalid", target.getName())); + } + downloadBuffer.clear(); + + int bytesRead, fullLength = 0; + + downloadMonitor.resetProgress(sizeGuess); + try + { + byte[] smallBuffer = new byte[1024]; + while ((bytesRead = is.read(smallBuffer)) >= 0) { + downloadBuffer.put(smallBuffer, 0, bytesRead); + fullLength += bytesRead; + downloadMonitor.updateProgress(fullLength); + } + is.close(); + downloadBuffer.limit(fullLength); + downloadBuffer.position(0); + } + catch (IOException e) + { + e.printStackTrace(); + } + + + try + { + String cksum = generateChecksum(downloadBuffer); + if (cksum.equals(validationHash)) + { + downloadBuffer.position(0); + FileOutputStream fos = new FileOutputStream(target); + fos.getChannel().write(downloadBuffer); + fos.close(); + } + else + { + throw new RuntimeException(String.format("The downloaded file %s has an invalid checksum %s (expecting %s). The download did not succeed correctly and the file has been deleted. Please try launching again.", target.getName(), cksum, validationHash)); + } + } + catch (Exception e) + { + if (e instanceof RuntimeException) throw (RuntimeException)e; + throw new RuntimeException(e); + } + + + + } + + private static String generateChecksum(ByteBuffer buffer) { try { - FileInputStream fis = new FileInputStream(file); - FileChannel chan = fis.getChannel(); MessageDigest digest = MessageDigest.getInstance("SHA-1"); - MappedByteBuffer mappedFile = chan.map(MapMode.READ_ONLY, 0, file.length()); - digest.update(mappedFile); - chan.close(); - fis.close(); + digest.update(buffer); byte[] chksum = digest.digest(); final StringBuilder hex = new StringBuilder( 2 * chksum.length ); for ( final byte b : chksum ) { @@ -415,37 +518,4 @@ public class RelaunchLibraryManager return null; } } - private static void downloadFile(File libFile, String rootUrl) - { - try - { - URL libDownload = new URL(String.format(rootUrl,libFile.getName())); - String infoString = String.format("Downloading file %s", libDownload.toString()); - FMLRelaunchLog.info(infoString); - InputStream urlStream = libDownload.openStream(); - urlStream = FMLRelauncher.instance().wrapStream(urlStream, infoString); - ReadableByteChannel urlChannel = Channels.newChannel(urlStream); - FileOutputStream libFileStream = new FileOutputStream(libFile); - FileChannel libFileChannel = libFileStream.getChannel(); - libFileChannel.transferFrom(urlChannel, 0, 1<<24); - libFileChannel.close(); - libFileStream.close(); - urlChannel.close(); - urlStream.close(); - FMLRelaunchLog.info("Download complete"); - } - catch (Exception e) - { - FMLRelaunchLog.severe("There was a problem downloading the file %s automatically. Perhaps you" + - "have an environment without internet access. You will need to download " + - "the file manually\n", libFile.getName()); - libFile.delete(); - throw new RuntimeException("A download error occured", e); - } - } - - public static List getLibraries() - { - return loadedLibraries; - } }