Instance: use getInstance()
[nikiroo-utils.git] / src / be / nikiroo / fanfix / reader / ui / GuiReaderMainPanel.java
index ea564ab2370df877345dca234b0c0bd2c30816f7..2843a0519a82c6a6771c659b6805c5baf2f4171a 100644 (file)
@@ -2,17 +2,22 @@ package be.nikiroo.fanfix.reader.ui;
 
 import java.awt.BorderLayout;
 import java.awt.Color;
+import java.awt.Component;
+import java.awt.EventQueue;
 import java.awt.Frame;
 import java.awt.Toolkit;
 import java.awt.datatransfer.DataFlavor;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
-import java.awt.event.MouseEvent;
+import java.awt.event.FocusAdapter;
+import java.awt.event.FocusEvent;
 import java.io.File;
 import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
 import java.net.URL;
 import java.net.UnknownHostException;
 import java.util.ArrayList;
+import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 import java.util.TreeMap;
@@ -29,6 +34,7 @@ import javax.swing.SwingConstants;
 import javax.swing.SwingUtilities;
 
 import be.nikiroo.fanfix.Instance;
+import be.nikiroo.fanfix.bundles.StringIdGui;
 import be.nikiroo.fanfix.bundles.UiConfig;
 import be.nikiroo.fanfix.data.MetaData;
 import be.nikiroo.fanfix.data.Story;
@@ -37,6 +43,7 @@ import be.nikiroo.fanfix.library.BasicLibrary.Status;
 import be.nikiroo.fanfix.library.LocalLibrary;
 import be.nikiroo.fanfix.reader.BasicReader;
 import be.nikiroo.fanfix.reader.ui.GuiReaderBook.BookActionListener;
+import be.nikiroo.fanfix.reader.ui.GuiReaderBookInfo.Type;
 import be.nikiroo.utils.Progress;
 import be.nikiroo.utils.ui.ProgressBar;
 
@@ -77,13 +84,13 @@ class GuiReaderMainPanel extends JPanel {
 
                /**
                 * Create the main menu bar.
+                * <p>
+                * Will invalidate the layout.
                 * 
-                * @param libOk
-                *            the library can be queried
-                * 
-                * @return the bar
+                * @param status
+                *            the library status, <b>must not</b> be NULL
                 */
-               public void createMenu(boolean b);
+               public void createMenu(Status status);
 
                /**
                 * Create a popup menu for a {@link GuiReaderBook} that represents a
@@ -103,26 +110,26 @@ class GuiReaderMainPanel extends JPanel {
        }
 
        /**
-        * A {@link Runnable} with a {@link Story} parameter.
+        * A {@link Runnable} with a {@link MetaData} parameter.
         * 
         * @author niki
         */
-       public interface StoryRunnable {
+       public interface MetaDataRunnable {
                /**
                 * Run the action.
                 * 
-                * @param story
-                *            the story
+                * @param meta
+                *            the meta of the story
                 */
-               public void run(Story story);
+               public void run(MetaData meta);
        }
 
        /**
         * Create a new {@link GuiReaderMainPanel}.
         * 
-        * @param reader
-        *            the associated {@link GuiReader} to forward some commands and
-        *            access its {@link LocalLibrary}
+        * @param parent
+        *            the associated {@link FrameHelper} to forward some commands
+        *            and access its {@link LocalLibrary}
         * @param type
         *            the type of {@link Story} to load, or NULL for all types
         */
@@ -133,16 +140,16 @@ class GuiReaderMainPanel extends JPanel {
 
                pane = new JPanel();
                pane.setLayout(new BoxLayout(pane, BoxLayout.PAGE_AXIS));
+               JScrollPane scroll = new JScrollPane(pane);
 
-               Integer icolor = Instance.getUiConfig().getColor(
-                               UiConfig.BACKGROUND_COLOR);
+               Integer icolor = Instance.getInstance().getUiConfig().getColor(UiConfig.BACKGROUND_COLOR);
                if (icolor != null) {
                        color = new Color(icolor);
                        setBackground(color);
                        pane.setBackground(color);
+                       scroll.setBackground(color);
                }
 
-               JScrollPane scroll = new JScrollPane(pane);
                scroll.getVerticalScrollBar().setUnitIncrement(16);
                add(scroll, BorderLayout.CENTER);
 
@@ -158,17 +165,17 @@ class GuiReaderMainPanel extends JPanel {
                pgBar.addActionListener(new ActionListener() {
                        @Override
                        public void actionPerformed(ActionEvent e) {
-                               invalidate();
+                               pgBar.invalidate();
                                pgBar.setProgress(null);
-                               validate();
                                setEnabled(true);
+                               validate();
                        }
                });
 
                pgBar.addUpdateListener(new ActionListener() {
                        @Override
                        public void actionPerformed(ActionEvent e) {
-                               invalidate();
+                               pgBar.invalidate();
                                validate();
                                repaint();
                        }
@@ -176,53 +183,60 @@ class GuiReaderMainPanel extends JPanel {
 
                books = new TreeMap<String, GuiReaderGroup>();
 
+               addFocusListener(new FocusAdapter() {
+                       @Override
+                       public void focusGained(FocusEvent e) {
+                               focus();
+                       }
+               });
+
                pane.setVisible(false);
                final Progress pg = new Progress();
                final String typeF = type;
-               outOfUi(pg, new Runnable() {
+               outOfUi(pg, true, new Runnable() {
                        @Override
                        public void run() {
-                               BasicLibrary lib = helper.getReader().getLibrary();
-                               Status status = lib.getStatus();
+                               final BasicLibrary lib = helper.getReader().getLibrary();
+                               final Status status = lib.getStatus();
 
-                               if (status == Status.READY) {
+                               if (status == Status.READ_WRITE) {
                                        lib.refresh(pg);
-                                       invalidate();
-                                       helper.createMenu(true);
-                                       if (typeF == null) {
-                                               addBookPane(true, false);
-                                       } else {
-                                               addBookPane(typeF, true);
-                                       }
-                                       refreshBooks();
-                                       validate();
-                                       pane.setVisible(true);
-                               } else {
-                                       invalidate();
-                                       helper.createMenu(false);
-                                       validate();
-
-                                       String err = lib.getLibraryName() + "\n";
-                                       switch (status) {
-                                       case INVALID:
-                                               err += "Library not valid";
-                                               break;
-
-                                       case UNAUTORIZED:
-                                               err += "You are not allowed to access this library";
-                                               break;
-
-                                       case UNAVAILABLE:
-                                               err += "Library currently unavailable";
-                                               break;
-
-                                       default:
-                                               err += "An error occured when contacting the library";
-                                               break;
-                                       }
-
-                                       error(err, "Library error", null);
                                }
+
+                               inUi(new Runnable() {
+                                       @Override
+                                       public void run() {
+                                               if (status.isReady()) {
+                                                       helper.createMenu(status);
+                                                       pane.setVisible(true);
+                                                       if (typeF == null) {
+                                                               try {
+                                                                       addBookPane(true, false);
+                                                               } catch (IOException e) {
+                                                                       error(e.getLocalizedMessage(),
+                                                                                       "IOException", e);
+                                                               }
+                                                       } else {
+                                                               addBookPane(typeF, true);
+                                                       }
+                                               } else {
+                                                       helper.createMenu(status);
+                                                       validate();
+
+                                                       String desc = Instance.getInstance().getTransGui().getStringX(StringIdGui.ERROR_LIB_STATUS,
+                                                                       status.toString());
+                                                       if (desc == null) {
+                                                               desc = GuiReader
+                                                                               .trans(StringIdGui.ERROR_LIB_STATUS);
+                                                       }
+
+                                                       String err = lib.getLibraryName() + "\n" + desc;
+                                                       error(err, GuiReader
+                                                                       .trans(StringIdGui.TITLE_ERROR_LIBRARY),
+                                                                       null);
+                                               }
+                                       }
+                               });
                        }
                });
        }
@@ -247,13 +261,17 @@ class GuiReaderMainPanel extends JPanel {
         * @param listMode
         *            TRUE to get a listing of all the sources or authors, FALSE to
         *            get one icon per source or author
+        * 
+        * @throws IOException
+        *             in case of I/O error
         */
-       public void addBookPane(boolean type, boolean listMode) {
+       public void addBookPane(boolean type, boolean listMode) throws IOException {
                this.currentType = type;
                BasicLibrary lib = helper.getReader().getLibrary();
                if (type) {
                        if (!listMode) {
-                               addListPane("Sources", lib.getSources(), type);
+                               addListPane(GuiReader.trans(StringIdGui.MENU_SOURCES),
+                                               lib.getSources(), type);
                        } else {
                                for (String tt : lib.getSources()) {
                                        if (tt != null) {
@@ -263,7 +281,8 @@ class GuiReaderMainPanel extends JPanel {
                        }
                } else {
                        if (!listMode) {
-                               addListPane("Authors", lib.getAuthors(), type);
+                               addListPane(GuiReader.trans(StringIdGui.MENU_AUTHORS),
+                                               lib.getAuthors(), type);
                        } else {
                                for (String tt : lib.getAuthors()) {
                                        if (tt != null) {
@@ -277,7 +296,8 @@ class GuiReaderMainPanel extends JPanel {
        /**
         * Add a new {@link GuiReaderGroup} on the frame to display the books of the
         * selected type or author.
-        * 
+        * <p>
+        * Will invalidate the layout.
         * 
         * @param value
         *            the author or the type, or NULL to get all the
@@ -293,11 +313,8 @@ class GuiReaderMainPanel extends JPanel {
 
                books.put(value, bookPane);
 
-               this.invalidate();
                pane.invalidate();
                pane.add(bookPane);
-               pane.validate();
-               this.validate();
 
                bookPane.setActionListener(new BookActionListener() {
                        @Override
@@ -306,9 +323,10 @@ class GuiReaderMainPanel extends JPanel {
                        }
 
                        @Override
-                       public void popupRequested(GuiReaderBook book, MouseEvent e) {
+                       public void popupRequested(GuiReaderBook book, Component target,
+                                       int x, int y) {
                                JPopupMenu popup = helper.createBookPopup();
-                               popup.show(e.getComponent(), e.getX(), e.getY());
+                               popup.show(target, x, y);
                        }
 
                        @Override
@@ -316,23 +334,26 @@ class GuiReaderMainPanel extends JPanel {
                                openBook(book);
                        }
                });
+
+               focus();
        }
 
        /**
         * Clear the pane from any book that may be present, usually prior to adding
         * new ones.
+        * <p>
+        * Will invalidate the layout.
         */
        public void removeBookPanes() {
                books.clear();
                pane.invalidate();
-               this.invalidate();
                pane.removeAll();
-               pane.validate();
-               this.validate();
        }
 
        /**
         * Refresh the list of {@link GuiReaderBook}s from disk.
+        * <p>
+        * Will validate the layout, as it is a "refresh" operation.
         */
        public void refreshBooks() {
                BasicLibrary lib = helper.getReader().getLibrary();
@@ -340,11 +361,17 @@ class GuiReaderMainPanel extends JPanel {
                        List<GuiReaderBookInfo> infos = new ArrayList<GuiReaderBookInfo>();
 
                        List<MetaData> metas;
-                       if (currentType) {
-                               metas = lib.getListBySource(value);
-                       } else {
-                               metas = lib.getListByAuthor(value);
+                       try {
+                               if (currentType) {
+                                       metas = lib.getListBySource(value);
+                               } else {
+                                       metas = lib.getListByAuthor(value);
+                               }
+                       } catch (IOException e) {
+                               error(e.getLocalizedMessage(), "IOException", e);
+                               metas = new ArrayList<MetaData>();
                        }
+
                        for (MetaData meta : metas) {
                                infos.add(GuiReaderBookInfo.fromMeta(meta));
                        }
@@ -356,8 +383,7 @@ class GuiReaderMainPanel extends JPanel {
                        bookPane.refreshBooks(words);
                }
 
-               pane.repaint();
-               this.repaint();
+               this.validate();
        }
 
        /**
@@ -368,7 +394,7 @@ class GuiReaderMainPanel extends JPanel {
         */
        public void openBook(final GuiReaderBook book) {
                final Progress pg = new Progress();
-               outOfUi(pg, new Runnable() {
+               outOfUi(pg, false, new Runnable() {
                        @Override
                        public void run() {
                                try {
@@ -381,8 +407,73 @@ class GuiReaderMainPanel extends JPanel {
                                                }
                                        });
                                } catch (IOException e) {
-                                       Instance.getTraceHandler().error(e);
-                                       error("Cannot open the selected book", "Error", e);
+                                       Instance.getInstance().getTraceHandler().error(e);
+                                       error(GuiReader.trans(StringIdGui.ERROR_CANNOT_OPEN),
+                                                       GuiReader.trans(StringIdGui.TITLE_ERROR), e);
+                               }
+                       }
+               });
+       }
+       
+       /**
+        * Prefetch a {@link GuiReaderBook} item (which can be a group, in which
+        * case we prefetch all its members).
+        * 
+        * @param book
+        *            the {@link GuiReaderBook} to open
+        */
+       public void prefetchBook(final GuiReaderBook book) {
+               final List<String> luids = new LinkedList<String>();
+               try {
+                       switch (book.getInfo().getType()) {
+                       case STORY:
+                               luids.add(book.getInfo().getMeta().getLuid());
+                               break;
+                       case SOURCE:
+                               for (MetaData meta : helper.getReader().getLibrary()
+                                               .getListBySource(book.getInfo().getMainInfo())) {
+                                       luids.add(meta.getLuid());
+                               }
+                               break;
+                       case AUTHOR:
+                               for (MetaData meta : helper.getReader().getLibrary()
+                                               .getListByAuthor(book.getInfo().getMainInfo())) {
+                                       luids.add(meta.getLuid());
+                               }
+                               break;
+                       }
+               } catch (IOException e) {
+                       Instance.getInstance().getTraceHandler().error(e);
+               }
+
+               final Progress pg = new Progress();
+               pg.setMax(luids.size());
+
+               outOfUi(pg, false, new Runnable() {
+                       @Override
+                       public void run() {
+                               try {
+                                       for (String luid : luids) {
+                                               Progress pgStep = new Progress();
+                                               pg.addProgress(pgStep, 1);
+
+                                               helper.getReader().prefetch(luid, pgStep);
+                                       }
+
+                                       // TODO: also set the green button on sources/authors?
+                                       // requires to do the same when all stories inside are green
+                                       if (book.getInfo().getType() == Type.STORY) {
+                                               SwingUtilities.invokeLater(new Runnable() {
+                                                       @Override
+                                                       public void run() {
+                                                               book.setCached(true);
+                                                       }
+                                               });
+                                       }
+                               } catch (IOException e) {
+                                       Instance.getInstance().getTraceHandler().error(e);
+                                       error(GuiReader.trans(StringIdGui.ERROR_CANNOT_OPEN),
+                                                       GuiReader.trans(StringIdGui.TITLE_ERROR), e);
                                }
                        }
                });
@@ -397,18 +488,27 @@ class GuiReaderMainPanel extends JPanel {
         * 
         * @param progress
         *            the {@link ProgressBar} or NULL
+        * @param refreshBooks
+        *            TRUE to refresh the books after
         * @param run
         *            the action to run
         */
-       public void outOfUi(Progress progress, final Runnable run) {
+       public void outOfUi(Progress progress, final boolean refreshBooks,
+                       final Runnable run) {
                final Progress pg = new Progress();
-               final Progress reload = new Progress("Reload books");
+               final Progress reload = new Progress(
+                               GuiReader.trans(StringIdGui.PROGRESS_OUT_OF_UI_RELOAD_BOOKS));
+
                if (progress == null) {
                        progress = new Progress();
                }
 
-               pg.addProgress(progress, 90);
-               pg.addProgress(reload, 10);
+               if (refreshBooks) {
+                       pg.addProgress(progress, 100);
+               } else {
+                       pg.addProgress(progress, 90);
+                       pg.addProgress(reload, 10);
+               }
 
                invalidate();
                pgBar.setProgress(pg);
@@ -420,7 +520,9 @@ class GuiReaderMainPanel extends JPanel {
                        public void run() {
                                try {
                                        run.run();
-                                       refreshBooks();
+                                       if (refreshBooks) {
+                                               refreshBooks();
+                                       }
                                } finally {
                                        reload.done();
                                        if (!pg.isDone()) {
@@ -432,6 +534,31 @@ class GuiReaderMainPanel extends JPanel {
                }, "outOfUi thread").start();
        }
 
+       /**
+        * Process the given action in the main Swing UI thread.
+        * <p>
+        * The code will make sure the current thread is the main UI thread and, if
+        * not, will switch to it before executing the runnable.
+        * <p>
+        * Synchronous operation.
+        * 
+        * @param run
+        *            the action to run
+        */
+       public void inUi(final Runnable run) {
+               if (EventQueue.isDispatchThread()) {
+                       run.run();
+               } else {
+                       try {
+                               EventQueue.invokeAndWait(run);
+                       } catch (InterruptedException e) {
+                               Instance.getInstance().getTraceHandler().error(e);
+                       } catch (InvocationTargetException e) {
+                               Instance.getInstance().getTraceHandler().error(e);
+                       }
+               }
+       }
+
        /**
         * Import a {@link Story} into the main {@link LocalLibrary}.
         * <p>
@@ -454,12 +581,14 @@ class GuiReaderMainPanel extends JPanel {
                                // No data will be handled
                        }
 
-                       if (clipboard == null || !clipboard.startsWith("http")) {
+                       if (clipboard == null || !(clipboard.startsWith("http://") || //
+                                       clipboard.startsWith("https://"))) {
                                clipboard = "";
                        }
 
                        url = JOptionPane.showInputDialog(GuiReaderMainPanel.this,
-                                       "url of the story to import?", "Importing from URL",
+                                       GuiReader.trans(StringIdGui.SUBTITLE_IMPORT_URL),
+                                       GuiReader.trans(StringIdGui.TITLE_IMPORT_URL),
                                        JOptionPane.QUESTION_MESSAGE, null, null, clipboard);
                } else if (fc.showOpenDialog(this) != JFileChooser.CANCEL_OPTION) {
                        url = fc.getSelectedFile().getAbsolutePath();
@@ -481,8 +610,10 @@ class GuiReaderMainPanel extends JPanel {
         *            the {@link Story} to import by {@link URL}
         * @param onSuccess
         *            Action to execute on success
+        * @param onSuccessPgName
+        *            the name to use for the onSuccess progress bar
         */
-       public void imprt(final String url, final StoryRunnable onSuccess,
+       public void imprt(final String url, final MetaDataRunnable onSuccess,
                        String onSuccessPgName) {
                final Progress pg = new Progress();
                final Progress pgImprt = new Progress();
@@ -490,13 +621,13 @@ class GuiReaderMainPanel extends JPanel {
                pg.addProgress(pgImprt, 95);
                pg.addProgress(pgOnSuccess, 5);
 
-               outOfUi(pg, new Runnable() {
+               outOfUi(pg, true, new Runnable() {
                        @Override
                        public void run() {
                                Exception ex = null;
-                               Story story = null;
+                               MetaData meta = null;
                                try {
-                                       story = helper.getReader().getLibrary()
+                                       meta = helper.getReader().getLibrary()
                                                        .imprt(BasicReader.getUrl(url), pgImprt);
                                } catch (IOException e) {
                                        ex = e;
@@ -509,15 +640,18 @@ class GuiReaderMainPanel extends JPanel {
                                pgOnSuccess.setProgress(0);
                                if (!ok) {
                                        if (e instanceof UnknownHostException) {
-                                               error("URL not supported: " + url, "Cannot import URL",
-                                                               null);
+                                               error(GuiReader.trans(
+                                                               StringIdGui.ERROR_URL_NOT_SUPPORTED, url),
+                                                               GuiReader.trans(StringIdGui.TITLE_ERROR), null);
                                        } else {
-                                               error("Failed to import " + url + ": \n"
-                                                               + e.getMessage(), "Cannot import URL", e);
+                                               error(GuiReader.trans(
+                                                               StringIdGui.ERROR_URL_IMPORT_FAILED, url,
+                                                               e.getMessage()), GuiReader
+                                                               .trans(StringIdGui.TITLE_ERROR), e);
                                        }
                                } else {
                                        if (onSuccess != null) {
-                                               onSuccess.run(story);
+                                               onSuccess.run(meta);
                                        }
                                }
                                pgOnSuccess.done();
@@ -593,9 +727,10 @@ class GuiReaderMainPanel extends JPanel {
                        }
 
                        @Override
-                       public void popupRequested(GuiReaderBook book, MouseEvent e) {
+                       public void popupRequested(GuiReaderBook book, Component target,
+                                       int x, int y) {
                                JPopupMenu popup = helper.createSourceAuthorPopup();
-                               popup.show(e.getComponent(), e.getX(), e.getY());
+                               popup.show(target, x, y);
                        }
 
                        @Override
@@ -605,6 +740,27 @@ class GuiReaderMainPanel extends JPanel {
                                refreshBooks();
                        }
                });
+
+               focus();
+       }
+
+       /**
+        * Focus the first {@link GuiReaderGroup} we find.
+        */
+       private void focus() {
+               GuiReaderGroup group = null;
+               Map<String, GuiReaderGroup> books = this.books;
+               if (books.size() > 0) {
+                       group = books.values().iterator().next();
+               }
+
+               if (group == null) {
+                       group = bookPane;
+               }
+
+               if (group != null) {
+                       group.requestFocusInWindow();
+               }
        }
 
        /**
@@ -618,9 +774,9 @@ class GuiReaderMainPanel extends JPanel {
         *            the exception to log if any
         */
        private void error(final String message, final String title, Exception e) {
-               Instance.getTraceHandler().error(title + ": " + message);
+               Instance.getInstance().getTraceHandler().error(title + ": " + message);
                if (e != null) {
-                       Instance.getTraceHandler().error(e);
+                       Instance.getInstance().getTraceHandler().error(e);
                }
 
                SwingUtilities.invokeLater(new Runnable() {