add javadoc
[jSite.git] / src / de / todesbaum / jsite / main / Main.java
index bfb5ef3..b00e020 100644 (file)
@@ -21,6 +21,7 @@ package de.todesbaum.jsite.main;
 
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.io.File;
 import java.io.IOException;
 import java.text.MessageFormat;
 import java.util.HashMap;
@@ -59,33 +60,82 @@ import de.todesbaum.util.swing.TWizardPage;
 import de.todesbaum.util.swing.WizardListener;
 
 /**
- * @author <a href="mailto:droden@gmail.com">David Roden </a>
- * @version $Id$
+ * The main class that ties together everything.
+ * 
+ * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  */
 public class Main implements ActionListener, ListSelectionListener, WizardListener, NodeManagerListener {
 
+       /** Whether the debug mode is activated. */
        private static boolean debug = false;
+
+       /** The configuration. */
        private Configuration configuration;
+
+       /** The freenet interface. */
        private Freenet7Interface freenetInterface = new Freenet7Interface();
-       protected Icon jSiteIcon;
 
+       /** The jSite icon. */
+       private Icon jSiteIcon;
+
+       /**
+        * Enumeration for all possible pages.
+        * 
+        * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
+        */
        private static enum PageType {
-               PAGE_NODE_MANAGER, PAGE_PROJECTS, PAGE_PROJECT_FILES, PAGE_INSERT_PROJECT
+
+               /** The node manager page. */
+               PAGE_NODE_MANAGER,
+
+               /** The project page. */
+               PAGE_PROJECTS,
+
+               /** The project files page. */
+               PAGE_PROJECT_FILES,
+
+               /** The project insert page. */
+               PAGE_INSERT_PROJECT
+
        }
 
-       private static final Locale[] SUPPORTED_LOCALES = new Locale[] { Locale.ENGLISH, Locale.GERMAN, Locale.FRENCH };
-       protected Map<Locale, Action> languageActions = new HashMap<Locale, Action>();
-       protected Action manageNodeAction;
-       protected Action aboutAction;
-       protected TWizard wizard;
-       protected JMenu nodeMenu;
+       /** The supported locales. */
+       private static final Locale[] SUPPORTED_LOCALES = new Locale[] { Locale.ENGLISH, Locale.GERMAN, Locale.FRENCH, Locale.ITALIAN, new Locale("pl") };
+
+       /** The actions that switch the language. */
+       private Map<Locale, Action> languageActions = new HashMap<Locale, Action>();
+
+       /** The “manage nodes” action. */
+       private Action manageNodeAction;
+
+       /** The “about jSite” action. */
+       private Action aboutAction;
+
+       /** The wizard. */
+       private TWizard wizard;
+
+       /** The node menu. */
+       private JMenu nodeMenu;
+
+       /** The currently selected node. */
        private Node selectedNode;
+
+       /** Mapping from page type to page. */
        private final Map<PageType, TWizardPage> pages = new HashMap<PageType, TWizardPage>();
 
+       /**
+        * Creates a new core with the default configuration file.
+        */
        private Main() {
                this(null);
        }
-       
+
+       /**
+        * Creates a new core with the given configuration from the given file.
+        * 
+        * @param configFilename
+        *            The name of the configuration file
+        */
        private Main(String configFilename) {
                if (configFilename != null) {
                        configuration = new Configuration(configFilename);
@@ -112,16 +162,22 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                showPage(PageType.PAGE_PROJECTS);
        }
 
+       /**
+        * Creates all actions.
+        */
        private void createActions() {
-               for (final Locale locale: SUPPORTED_LOCALES) {
-                       languageActions.put(locale, new AbstractAction(I18n.getMessage("jsite.menu.language." + locale.getLanguage())) {
+               for (final Locale locale : SUPPORTED_LOCALES) {
+                       languageActions.put(locale, new AbstractAction(I18n.getMessage("jsite.menu.language." + locale.getLanguage()), IconLoader.loadIcon("/flag-" + locale.getLanguage() + ".png")) {
 
+                               @SuppressWarnings("synthetic-access")
                                public void actionPerformed(ActionEvent actionEvent) {
                                        switchLanguage(locale);
                                }
                        });
                }
                manageNodeAction = new AbstractAction(I18n.getMessage("jsite.menu.nodes.manage-nodes")) {
+
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                showPage(PageType.PAGE_NODE_MANAGER);
                                wizard.setPreviousName(I18n.getMessage("jsite.wizard.previous"));
@@ -130,12 +186,15 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                };
                aboutAction = new AbstractAction(I18n.getMessage("jsite.menu.help.about")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent e) {
                                JOptionPane.showMessageDialog(wizard, MessageFormat.format(I18n.getMessage("jsite.about.message"), Version.getVersion()), null, JOptionPane.INFORMATION_MESSAGE, jSiteIcon);
                        }
                };
-               
+
                I18nContainer.getInstance().registerRunnable(new Runnable() {
+
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                manageNodeAction.putValue(Action.NAME, I18n.getMessage("jsite.menu.nodes.manage-nodes"));
                                aboutAction.putValue(Action.NAME, I18n.getMessage("jsite.menu.help.about"));
@@ -143,12 +202,17 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                });
        }
 
+       /**
+        * Creates the menu bar.
+        * 
+        * @return The menu bar
+        */
        private JMenuBar createMenuBar() {
                JMenuBar menuBar = new JMenuBar();
                final JMenu languageMenu = new JMenu(I18n.getMessage("jsite.menu.languages"));
                menuBar.add(languageMenu);
                ButtonGroup languageButtonGroup = new ButtonGroup();
-               for (Locale locale: SUPPORTED_LOCALES) {
+               for (Locale locale : SUPPORTED_LOCALES) {
                        Action languageAction = languageActions.get(locale);
                        JRadioButtonMenuItem menuItem = new JRadioButtonMenuItem(languageActions.get(locale));
                        if (locale.equals(Locale.getDefault())) {
@@ -171,21 +235,26 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                final JMenu helpMenu = new JMenu(I18n.getMessage("jsite.menu.help"));
                menuBar.add(helpMenu);
                helpMenu.add(aboutAction);
-               
+
                I18nContainer.getInstance().registerRunnable(new Runnable() {
+
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                languageMenu.setText(I18n.getMessage("jsite.menu.languages"));
                                nodeMenu.setText(I18n.getMessage("jsite.menu.nodes"));
                                helpMenu.setText(I18n.getMessage("jsite.menu.help"));
-                               for (Map.Entry<Locale, Action> languageActionEntry: languageActions.entrySet()) {
+                               for (Map.Entry<Locale, Action> languageActionEntry : languageActions.entrySet()) {
                                        languageActionEntry.getValue().putValue(Action.NAME, I18n.getMessage("jsite.menu.language." + languageActionEntry.getKey().getLanguage()));
                                }
                        }
                });
-               
+
                return menuBar;
        }
 
+       /**
+        * Initializes all pages.
+        */
        private void initPages() {
                NodeManagerPage nodeManagerPage = new NodeManagerPage(wizard);
                nodeManagerPage.setName("page.node-manager");
@@ -211,13 +280,25 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                pages.put(PageType.PAGE_INSERT_PROJECT, projectInsertPage);
        }
 
-       protected void showPage(PageType pageType) {
+       /**
+        * Shows the page with the given type.
+        * 
+        * @param pageType
+        *            The page type to show
+        */
+       private void showPage(PageType pageType) {
                wizard.setPreviousEnabled(pageType.ordinal() > 0);
                wizard.setNextEnabled(pageType.ordinal() < (pages.size() - 1));
                wizard.setPage(pages.get(pageType));
                wizard.setTitle(pages.get(pageType).getHeading() + " - jSite");
        }
 
+       /**
+        * Saves the configuration.
+        * 
+        * @return <code>true</code> if the configuration could be saved,
+        *         <code>false</code> otherwise
+        */
        private boolean saveConfiguration() {
                NodeManagerPage nodeManagerPage = (NodeManagerPage) pages.get(PageType.PAGE_NODE_MANAGER);
                configuration.setNodes(nodeManagerPage.getNodes());
@@ -231,18 +312,26 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                return configuration.save();
        }
 
+       /**
+        * Finds a supported locale for the given locale.
+        * 
+        * @param forLocale
+        *            The locale to find a supported locale for
+        * @return The supported locale that was found, or the default locale if no
+        *         supported locale could be found
+        */
        private Locale findSupportedLocale(Locale forLocale) {
-               for (Locale locale: SUPPORTED_LOCALES) {
+               for (Locale locale : SUPPORTED_LOCALES) {
                        if (locale.equals(forLocale)) {
                                return locale;
                        }
                }
-               for (Locale locale: SUPPORTED_LOCALES) {
+               for (Locale locale : SUPPORTED_LOCALES) {
                        if (locale.getCountry().equals(forLocale.getCountry()) && locale.getLanguage().equals(forLocale.getLanguage())) {
                                return locale;
                        }
                }
-               for (Locale locale: SUPPORTED_LOCALES) {
+               for (Locale locale : SUPPORTED_LOCALES) {
                        if (locale.getLanguage().equals(forLocale.getLanguage())) {
                                return locale;
                        }
@@ -254,13 +343,19 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
        // ACTIONS
        //
 
-       protected void switchLanguage(Locale locale) {
+       /**
+        * Switches the language of the interface to the given locale.
+        * 
+        * @param locale
+        *            The locale to switch to
+        */
+       private void switchLanguage(Locale locale) {
                Locale supportedLocale = findSupportedLocale(locale);
                Action languageAction = languageActions.get(supportedLocale);
                JRadioButtonMenuItem menuItem = (JRadioButtonMenuItem) languageAction.getValue("menuItem");
                menuItem.setSelected(true);
                I18n.setLocale(supportedLocale);
-               for (Runnable i18nRunnable: I18nContainer.getInstance()) {
+               for (Runnable i18nRunnable : I18nContainer.getInstance()) {
                        try {
                                i18nRunnable.run();
                        } catch (Throwable t) {
@@ -320,20 +415,28 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                                if (JOptionPane.showConfirmDialog(wizard, I18n.getMessage("jsite.project-files.empty-index"), null, JOptionPane.OK_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE) != JOptionPane.OK_OPTION) {
                                        return;
                                }
+                       } else {
+                               File indexFile = new File(project.getLocalPath(), project.getIndexFile());
+                               if (!indexFile.exists()) {
+                                       JOptionPane.showMessageDialog(wizard, I18n.getMessage("jsite.project-files.index-missing"), null, JOptionPane.ERROR_MESSAGE);
+                                       return;
+                               }
                        }
-                       if (!project.getFileOption(project.getIndexFile()).getContainer().equals("")) {
+                       String indexFile = project.getIndexFile();
+                       boolean hasIndexFile = (indexFile != null);
+                       if (hasIndexFile && !project.getFileOption(indexFile).getContainer().equals("")) {
                                if (JOptionPane.showConfirmDialog(wizard, I18n.getMessage("jsite.project-files.container-index"), null, JOptionPane.OK_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE) != JOptionPane.OK_OPTION) {
                                        return;
                                }
                        }
-                       if (!project.getFileOption(project.getIndexFile()).getMimeType().equals("text/html")) {
+                       if (hasIndexFile && !project.getFileOption(indexFile).getMimeType().equals("text/html")) {
                                if (JOptionPane.showConfirmDialog(wizard, I18n.getMessage("jsite.project-files.index-not-html"), null, JOptionPane.OK_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE) != JOptionPane.OK_OPTION) {
                                        return;
                                }
                        }
                        Map<String, FileOption> fileOptions = project.getFileOptions();
                        Set<Entry<String, FileOption>> fileOptionEntries = fileOptions.entrySet();
-                       for (Entry<String, FileOption> fileOptionEntry: fileOptionEntries) {
+                       for (Entry<String, FileOption> fileOptionEntry : fileOptionEntries) {
                                FileOption fileOption = fileOptionEntry.getValue();
                                if (!fileOption.isInsert() && ((fileOption.getCustomKey().length() == 0) || "CHK@".equals(fileOption.getCustomKey()))) {
                                        JOptionPane.showMessageDialog(wizard, MessageFormat.format(I18n.getMessage("jsite.project-files.no-custom-key"), fileOptionEntry.getKey()), null, JOptionPane.ERROR_MESSAGE);
@@ -344,6 +447,7 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                        try {
                                nodeRunning = freenetInterface.isNodePresent();
                        } catch (IOException e) {
+                               /* ignore. */
                        }
                        if (!nodeRunning) {
                                JOptionPane.showMessageDialog(wizard, I18n.getMessage("jsite.project-files.no-node-running"), null, JOptionPane.ERROR_MESSAGE);
@@ -398,7 +502,7 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                nodeMenu.removeAll();
                ButtonGroup nodeButtonGroup = new ButtonGroup();
                Node newSelectedNode = null;
-               for (Node node: nodes) {
+               for (Node node : nodes) {
                        JRadioButtonMenuItem nodeMenuItem = new JRadioButtonMenuItem(node.getName());
                        nodeMenuItem.putClientProperty("Node", node);
                        nodeMenuItem.addActionListener(this);
@@ -431,10 +535,17 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
        //
        // MAIN METHOD
        //
+
+       /**
+        * Main method that is called by the VM.
+        * 
+        * @param args
+        *            The command-line arguments
+        */
        public static void main(String[] args) {
                String configFilename = null;
                boolean nextIsConfigFilename = false;
-               for (String argument: args) {
+               for (String argument : args) {
                        if (nextIsConfigFilename) {
                                configFilename = argument;
                                nextIsConfigFilename = false;
@@ -455,10 +566,13 @@ public class Main implements ActionListener, ListSelectionListener, WizardListen
                new Main(configFilename);
        }
 
+       /**
+        * Prints a small syntax help.
+        */
        private static void printHelp() {
                System.out.println("--help\tshows this cruft");
                System.out.println("--debug\tenables some debug output");
                System.out.println("--config-file <file>\tuse specified configuration file");
        }
-       
+
 }