Don’t update the progress bar if the progress is 0.
[jSite.git] / src / de / todesbaum / jsite / gui / ProjectInsertPage.java
index f5990b4..99b2b81 100644 (file)
@@ -1,6 +1,5 @@
 /*
- * jSite - a tool for uploading websites into Freenet
- * Copyright (C) 2006 David Roden
+ * jSite - ProjectInsertPage.java - Copyright © 2006–2011 David Roden
  *
  * 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
@@ -34,6 +33,8 @@ import java.awt.event.KeyEvent;
 import java.text.DateFormat;
 import java.text.MessageFormat;
 import java.util.Date;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 import javax.swing.AbstractAction;
 import javax.swing.Action;
@@ -46,29 +47,60 @@ import javax.swing.JProgressBar;
 import javax.swing.JTextField;
 import javax.swing.SwingUtilities;
 
+import de.todesbaum.jsite.application.AbortedException;
 import de.todesbaum.jsite.application.Freenet7Interface;
 import de.todesbaum.jsite.application.InsertListener;
 import de.todesbaum.jsite.application.Project;
 import de.todesbaum.jsite.application.ProjectInserter;
 import de.todesbaum.jsite.i18n.I18n;
 import de.todesbaum.jsite.i18n.I18nContainer;
+import de.todesbaum.util.io.StreamCopier.ProgressListener;
 import de.todesbaum.util.swing.TWizard;
 import de.todesbaum.util.swing.TWizardPage;
 
 /**
- * @author David Roden <droden@gmail.com>
- * @version $Id$
+ * Wizard page that shows the progress of an insert.
+ *
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
  */
 public class ProjectInsertPage extends TWizardPage implements InsertListener, ClipboardOwner {
 
-       protected ProjectInserter projectInserter;
+       /** The logger. */
+       private static final Logger logger = Logger.getLogger(ProjectInsertPage.class.getName());
+
+       /** The project inserter. */
+       private ProjectInserter projectInserter;
+
+       /** The “copy URI” action. */
+       private Action copyURIAction;
+
+       /** The “request URI” textfield. */
+       private JTextField requestURITextField;
+
+       /** The “start time” label. */
+       private JLabel startTimeLabel;
+
+       /** The progress bar. */
+       private JProgressBar progressBar;
+
+       /** The start time of the insert. */
+       private long startTime = 0;
+
+       /** The number of inserted blocks. */
+       private volatile int insertedBlocks;
+
+       /** Whether the “copy URI to clipboard” button was used. */
+       private boolean uriCopied;
 
-       protected Action copyURIAction;
-       protected JTextField requestURITextField;
-       protected JLabel startTimeLabel;
-       protected JProgressBar progressBar;
-       protected long startTime = 0;
+       /** Whether the insert is currently running. */
+       private volatile boolean running = false;
 
+       /**
+        * Creates a new progress insert wizard page.
+        *
+        * @param wizard
+        *            The wizard this page belongs to
+        */
        public ProjectInsertPage(final TWizard wizard) {
                super(wizard);
                createActions();
@@ -86,8 +118,13 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
                projectInserter.addInsertListener(this);
        }
 
+       /**
+        * Creates all used actions.
+        */
        private void createActions() {
                copyURIAction = new AbstractAction(I18n.getMessage("jsite.project.action.copy-uri")) {
+
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionCopyURI();
                        }
@@ -98,6 +135,7 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
 
                I18nContainer.getInstance().registerRunnable(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                copyURIAction.putValue(Action.NAME, I18n.getMessage("jsite.project.action.copy-uri"));
                                copyURIAction.putValue(Action.SHORT_DESCRIPTION, I18n.getMessage("jsite.project.action.copy-uri.tooltip"));
@@ -105,11 +143,19 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
                });
        }
 
+       /**
+        * Initializes the page.
+        */
        private void pageInit() {
                setLayout(new BorderLayout(12, 12));
                add(createProjectInsertPanel(), BorderLayout.CENTER);
        }
 
+       /**
+        * Creates the main panel.
+        *
+        * @return The main panel
+        */
        private JComponent createProjectInsertPanel() {
                JComponent projectInsertPanel = new JPanel(new GridBagLayout());
 
@@ -133,10 +179,11 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
                final JLabel progressLabel = new JLabel(I18n.getMessage("jsite.insert.progress") + ":");
                projectInsertPanel.add(progressLabel, new GridBagConstraints(0, 3, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 18, 0, 0), 0, 0));
                projectInsertPanel.add(progressBar, new GridBagConstraints(1, 3, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
-               projectInsertPanel.add(new JButton(copyURIAction), new GridBagConstraints(0, 4, 2, 1, 0.0, 0.0, GridBagConstraints.LINE_END, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
+               projectInsertPanel.add(new JButton(copyURIAction), new GridBagConstraints(0, 4, 2, 1, 0.0, 0.0, GridBagConstraints.LINE_END, GridBagConstraints.NONE, new Insets(12, 18, 0, 0), 0, 0));
 
                I18nContainer.getInstance().registerRunnable(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                projectInformationLabel.setText("<html><b>" + I18n.getMessage("jsite.insert.project-information") + "</b></html>");
                                requestURILabel.setText(I18n.getMessage("jsite.insert.request-uri") + ":");
@@ -160,45 +207,111 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
        public void pageAdded(TWizard wizard) {
                this.wizard.setPreviousName(I18n.getMessage("jsite.wizard.previous"));
                this.wizard.setPreviousEnabled(false);
-               this.wizard.setNextName(I18n.getMessage("jsite.wizard.next"));
+               this.wizard.setNextName(I18n.getMessage("jsite.general.cancel"));
                this.wizard.setQuitName(I18n.getMessage("jsite.wizard.quit"));
        }
 
+       /**
+        * Starts the insert.
+        */
        public void startInsert() {
-               wizard.setNextEnabled(false);
+               running = true;
                copyURIAction.setEnabled(false);
                progressBar.setValue(0);
                progressBar.setString(I18n.getMessage("jsite.insert.starting"));
                progressBar.setFont(progressBar.getFont().deriveFont(Font.PLAIN));
-               projectInserter.start();
+               projectInserter.start(new ProgressListener() {
+
+                       public void onProgress(final long copied, final long length) {
+                               SwingUtilities.invokeLater(new Runnable() {
+
+                                       /**
+                                        * {@inheritDoc}
+                                        */
+                                       @SuppressWarnings("synthetic-access")
+                                       public void run() {
+                                               int divisor = 1;
+                                               while (((copied / divisor) > Integer.MAX_VALUE) || ((length / divisor) > Integer.MAX_VALUE)) {
+                                                       divisor *= 10;
+                                               }
+                                               progressBar.setMaximum((int) (length / divisor));
+                                               progressBar.setValue((int) (copied / divisor));
+                                               progressBar.setString("Uploaded: " + copied + " / " + length);
+                                       }
+                               });
+                       }
+               });
+       }
+
+       /**
+        * Stops the currently running insert.
+        */
+       public void stopInsert() {
+               if (running) {
+                       wizard.setNextEnabled(false);
+                       projectInserter.stop();
+               }
        }
 
        /**
-        * @param debug
-        *            The debug to set.
+        * Returns whether the insert is currently running.
+        *
+        * @return {@code true} if the insert is currently running, {@code false}
+        *         otherwise
         */
-       public void setDebug(boolean debug) {
-               projectInserter.setDebug(debug);
+       public boolean isRunning() {
+               return running;
        }
 
        /**
+        * Sets the project to insert.
+        *
         * @param project
-        *            The project to set.
+        *            The project to insert
         */
        public void setProject(final Project project) {
                projectInserter.setProject(project);
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                requestURITextField.setText(project.getFinalRequestURI(1));
                        }
                });
        }
 
+       /**
+        * Sets the freenet interface to use.
+        *
+        * @param freenetInterface
+        *            The freenet interface to use
+        */
        public void setFreenetInterface(Freenet7Interface freenetInterface) {
                projectInserter.setFreenetInterface(freenetInterface);
        }
 
+       /**
+        * Sets the project inserter’s temp directory.
+        *
+        * @see ProjectInserter#setTempDirectory(String)
+        * @param tempDirectory
+        *            The temp directory to use, or {@code null} to use the system
+        *            default
+        */
+       public void setTempDirectory(String tempDirectory) {
+               projectInserter.setTempDirectory(tempDirectory);
+       }
+
+       /**
+        * Returns whether the “copy URI to clipboard” button was used.
+        *
+        * @return {@code true} if an URI was copied to clipboard, {@code false}
+        *         otherwise
+        */
+       public boolean wasUriCopied() {
+               return uriCopied;
+       }
+
        //
        // INTERFACE InsertListener
        //
@@ -207,11 +320,27 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
         * {@inheritDoc}
         */
        public void projectInsertStarted(final Project project) {
+
+               SwingUtilities.invokeLater(new Runnable() {
+
+                       @SuppressWarnings("synthetic-access")
+                       public void run() {
+                               startTimeLabel.setText(DateFormat.getDateTimeInstance().format(new Date()));
+                       }
+               });
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       public void projectUploadFinished(Project project) {
                startTime = System.currentTimeMillis();
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
-                               startTimeLabel.setText(DateFormat.getDateTimeInstance().format(new Date(startTime)));
+                               progressBar.setString(I18n.getMessage("jsite.insert.starting"));
+                               progressBar.setValue(0);
                        }
                });
        }
@@ -221,27 +350,55 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
         */
        public void projectURIGenerated(Project project, final String uri) {
                SwingUtilities.invokeLater(new Runnable() {
+
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                copyURIAction.setEnabled(true);
                                requestURITextField.setText(uri);
                        }
                });
+               logger.log(Level.FINEST, "Insert generated URI: " + uri);
+               int slash = uri.indexOf('/');
+               slash = uri.indexOf('/', slash + 1);
+               int secondSlash = uri.indexOf('/', slash + 1);
+               if (secondSlash == -1) {
+                       secondSlash = uri.length();
+               }
+               String editionNumber = uri.substring(slash + 1, secondSlash);
+               logger.log(Level.FINEST, "Extracted edition number: " + editionNumber);
+               int edition = -1;
+               try {
+                       edition = Integer.valueOf(editionNumber);
+               } catch (NumberFormatException nfe1) {
+                       /* ignore. */
+               }
+               logger.log(Level.FINEST, "Insert edition: " + edition + ", Project edition: " + project.getEdition());
+               if ((edition != -1) && (edition == project.getEdition())) {
+                       JOptionPane.showMessageDialog(this, I18n.getMessage("jsite.insert.reinserted-edition"), I18n.getMessage("jsite.insert.reinserted-edition.title"), JOptionPane.INFORMATION_MESSAGE);
+               }
        }
 
        /**
         * {@inheritDoc}
         */
        public void projectInsertProgress(Project project, final int succeeded, final int failed, final int fatal, final int total, final boolean finalized) {
+               insertedBlocks = succeeded;
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
+                               if (total == 0) {
+                                       return;
+                               }
                                progressBar.setMaximum(total);
                                progressBar.setValue(succeeded + failed + fatal);
                                int progress = (succeeded + failed + fatal) * 100 / total;
                                StringBuilder progressString = new StringBuilder();
                                progressString.append(progress).append("% (");
-                               progressString.append(succeeded + failed + fatal).append("/").append(total);
-                               progressString.append(")");
+                               progressString.append(succeeded + failed + fatal).append('/').append(total);
+                               progressString.append(") (");
+                               progressString.append(getTransferRate());
+                               progressString.append(' ').append(I18n.getMessage("jsite.insert.k-per-s")).append(')');
                                progressBar.setString(progressString.toString());
                                if (finalized) {
                                        progressBar.setFont(progressBar.getFont().deriveFont(Font.BOLD));
@@ -254,20 +411,31 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
         * {@inheritDoc}
         */
        public void projectInsertFinished(Project project, boolean success, Throwable cause) {
+               running = false;
                if (success) {
-                       JOptionPane.showMessageDialog(this, I18n.getMessage("jsite.insert.inserted"), null, JOptionPane.INFORMATION_MESSAGE);
+                       String copyURILabel = I18n.getMessage("jsite.insert.okay-copy-uri");
+                       int selectedValue = JOptionPane.showOptionDialog(this, I18n.getMessage("jsite.insert.inserted"), I18n.getMessage("jsite.insert.done.title"), 0, JOptionPane.INFORMATION_MESSAGE, null, new Object[] { I18n.getMessage("jsite.general.ok"), copyURILabel }, copyURILabel);
+                       if (selectedValue == 1) {
+                               actionCopyURI();
+                       }
                } else {
                        if (cause == null) {
-                               JOptionPane.showMessageDialog(this, I18n.getMessage("jsite.insert.insert-failed"), null, JOptionPane.ERROR_MESSAGE);
+                               JOptionPane.showMessageDialog(this, I18n.getMessage("jsite.insert.insert-failed"), I18n.getMessage("jsite.insert.insert-failed.title"), JOptionPane.ERROR_MESSAGE);
                        } else {
-                               JOptionPane.showMessageDialog(this, MessageFormat.format(I18n.getMessage("jsite.insert.insert-failed-with-cause"), cause.getMessage()), null, JOptionPane.ERROR_MESSAGE);
+                               if (cause instanceof AbortedException) {
+                                       JOptionPane.showMessageDialog(this, I18n.getMessage("jsite.insert.insert-aborted"), I18n.getMessage("jsite.insert.insert-aborted.title"), JOptionPane.INFORMATION_MESSAGE);
+                               } else {
+                                       JOptionPane.showMessageDialog(this, MessageFormat.format(I18n.getMessage("jsite.insert.insert-failed-with-cause"), cause.getMessage()), I18n.getMessage("jsite.insert.insert-failed.title"), JOptionPane.ERROR_MESSAGE);
+                               }
                        }
                }
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                progressBar.setValue(progressBar.getMaximum());
-                               progressBar.setString(I18n.getMessage("jsite.insert.done"));
+                               progressBar.setString(I18n.getMessage("jsite.insert.done") + " (" + getTransferRate() + " " + I18n.getMessage("jsite.insert.k-per-s") + ")");
+                               wizard.setNextName(I18n.getMessage("jsite.wizard.next"));
                                wizard.setNextEnabled(true);
                                wizard.setQuitEnabled(true);
                        }
@@ -278,11 +446,46 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
        // ACTIONS
        //
 
-       protected void actionCopyURI() {
+       /**
+        * Copies the request URI of the project to the clipboard.
+        */
+       private void actionCopyURI() {
+               uriCopied = true;
                Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
                clipboard.setContents(new StringSelection(requestURITextField.getText()), this);
        }
 
+       /**
+        * Formats the given number so that it always has the the given number of
+        * fractional digits.
+        *
+        * @param number
+        *            The number to format
+        * @param digits
+        *            The number of fractional digits
+        * @return The formatted number
+        */
+       private String formatNumber(double number, int digits) {
+               int multiplier = (int) Math.pow(10, digits);
+               String formattedNumber = String.valueOf((int) (number * multiplier) / (double) multiplier);
+               if (formattedNumber.indexOf('.') == -1) {
+                       formattedNumber += '.';
+                       for (int digit = 0; digit < digits; digit++) {
+                               formattedNumber += "0";
+                       }
+               }
+               return formattedNumber;
+       }
+
+       /**
+        * Returns the formatted transfer rate at this point.
+        *
+        * @return The formatted transfer rate
+        */
+       private String getTransferRate() {
+               return formatNumber(insertedBlocks * 32.0 / ((System.currentTimeMillis() - startTime) / 1000), 1);
+       }
+
        //
        // INTERFACE ClipboardOwner
        //
@@ -291,6 +494,7 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener, Cl
         * {@inheritDoc}
         */
        public void lostOwnership(Clipboard clipboard, Transferable contents) {
+               /* ignore. */
        }
 
 }