Add missing javadoc.
[xudocci.git] / src / main / java / net / pterodactylus / xdcc / ui / stdin / CommandReader.java
index 29c77ec..2a6ec83 100644 (file)
 
 package net.pterodactylus.xdcc.ui.stdin;
 
+import static com.google.common.collect.Lists.newArrayList;
+import static net.pterodactylus.xdcc.data.Download.BY_NAME;
+import static net.pterodactylus.xdcc.data.Download.BY_RUNNING;
+
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.Reader;
 import java.io.Writer;
+import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.Comparator;
 import java.util.List;
 import java.util.Set;
+import java.util.regex.Pattern;
 
+import net.pterodactylus.irc.Connection;
 import net.pterodactylus.irc.DccReceiver;
+import net.pterodactylus.irc.util.MessageCleaner;
 import net.pterodactylus.xdcc.core.Core;
 import net.pterodactylus.xdcc.core.event.DownloadFailed;
 import net.pterodactylus.xdcc.core.event.DownloadFinished;
 import net.pterodactylus.xdcc.core.event.DownloadStarted;
+import net.pterodactylus.xdcc.core.event.GenericMessage;
+import net.pterodactylus.xdcc.core.event.MessageReceived;
 import net.pterodactylus.xdcc.data.Bot;
 import net.pterodactylus.xdcc.data.Download;
 import net.pterodactylus.xdcc.data.Pack;
 
+import com.google.common.base.Predicate;
+import com.google.common.collect.ComparisonChain;
+import com.google.common.collect.FluentIterable;
 import com.google.common.collect.Lists;
+import com.google.common.collect.Ordering;
 import com.google.common.collect.Sets;
 import com.google.common.eventbus.Subscribe;
 import com.google.common.primitives.Ints;
@@ -81,16 +96,16 @@ public class CommandReader extends AbstractExecutionThreadService {
        protected void run() throws Exception {
                String lastLine = "";
                String line;
-               final List<Result> lastResult = Lists.newArrayList();
+               State state = new State();
                while ((line = reader.readLine()) != null) {
                        if (line.equals("")) {
                                line = lastLine;
                        }
                        String[] words = line.split(" +");
                        if (words[0].equalsIgnoreCase("search")) {
-                               lastResult.clear();
-                               for (Bot bot : core.bots()) {
-                                       for (Pack pack : bot) {
+                               List<Result> lastResult = newArrayList();
+                               for (Bot bot : newArrayList(core.bots())) {
+                                       for (Pack pack : newArrayList(bot)) {
                                                boolean found = true;
                                                for (int wordIndex = 1; wordIndex < words.length; ++wordIndex) {
                                                        if (words[wordIndex].startsWith("-") && pack.name().toLowerCase().contains(words[wordIndex].toLowerCase().substring(1))) {
@@ -113,26 +128,40 @@ public class CommandReader extends AbstractExecutionThreadService {
                                        writeLine(String.format("[%d] %s (%s) from %s (#%s) on %s", counter++, result.pack().name(), result.pack().size(), result.bot().name(), result.pack().id(), result.bot().network().name()));
                                }
                                writeLine("End of Search.");
+                               state = state.setLastResults(lastResult);
                        } else if (words[0].equalsIgnoreCase("dcc")) {
                                int counter = 0;
-                               for (DccReceiver dccReceiver : core.dccReceivers()) {
-                                       write(String.format("[%d] %s (%s, ", counter++, dccReceiver.filename(), dccReceiver.size()));
+                               List<Download> downloads = newArrayList(FluentIterable.from(core.downloads()).toSortedList(Ordering.from(BY_NAME).compound(BY_RUNNING)));
+                               for (Download download : downloads) {
+                                       DccReceiver dccReceiver = download.dccReceiver();
+                                       if (dccReceiver == null) {
+                                               /* download has not even started. */
+                                               writer.write(String.format("[%d] %s requested from %s (not started yet)\n", counter++, download.pack().name(), download.bot().name()));
+                                               continue;
+                                       }
+                                       writer.write(String.format("[%d] %s from %s (%s, ", counter++, dccReceiver.filename(), download.bot().name(), f(dccReceiver.size())));
                                        if (dccReceiver.isRunning()) {
-                                               write(String.format("%.1f%%, %s", dccReceiver.progress() * 100.0 / dccReceiver.size(), f(dccReceiver.currentRate())));
+                                               writer.write(String.format("%.1f%%, %s/s, %s", dccReceiver.progress() * 100.0 / dccReceiver.size(), f(dccReceiver.currentRate()), getTimeLeft(dccReceiver)));
                                        } else {
                                                if (dccReceiver.progress() >= dccReceiver.size()) {
-                                                       write(String.format("complete, %s", f(dccReceiver.overallRate())));
+                                                       writer.write(String.format("complete, %s/s", f(dccReceiver.overallRate())));
                                                } else {
-                                                       write(String.format("aborted at %.1f%%, %s", dccReceiver.progress() * 100.0 / dccReceiver.size(), f(dccReceiver.currentRate())));
+                                                       writer.write(String.format("aborted at %.1f%%, %s/s", dccReceiver.progress() * 100.0 / dccReceiver.size(), f(dccReceiver.currentRate())));
                                                }
                                        }
-                                       write("/s)\n");
+                                       writer.write(")\n");
                                }
                                writeLine("End of DCCs.");
+                               state = state.setLastDownloads(downloads);
                        } else if (words[0].equalsIgnoreCase("get")) {
                                Integer index = Ints.tryParse(words[1]);
-                               if ((index != null) && (index < lastResult.size())) {
-                                       core.fetch(lastResult.get(index).bot(), lastResult.get(index).pack());
+                               if ((index != null) && (index < state.getLastResults().size())) {
+                                       core.fetch(state.getLastResults().get(index).bot(), state.getLastResults().get(index).pack());
+                               }
+                       } else if (words[0].equalsIgnoreCase("cancel")) {
+                               Integer index = Ints.tryParse(words[1]);
+                               if ((index != null) && (index < state.getLastDownloads().size())) {
+                                       core.cancelDownload(state.getLastDownloads().get(index).bot(), state.getLastDownloads().get(index).pack());
                                }
                        } else if (words[0].equalsIgnoreCase("stats")) {
                                int configuredChannelsCount = core.channels().size();
@@ -149,6 +178,26 @@ public class CommandReader extends AbstractExecutionThreadService {
                                }
 
                                writeLine(String.format("%d channels (%d joined, %d extra), %d bots offering %d packs (%d unique).", configuredChannelsCount, joinedChannelsCount, extraChannelsCount, bots.size(), packsCount, packNames.size()));
+                       } else if (words[0].equalsIgnoreCase("connections")) {
+                               List<Connection> lastConnections = newArrayList();
+                               int counter = 0;
+                               for (Connection connection : core.connections()) {
+                                       lastConnections.add(connection);
+                                       writer.write(String.format("[%d] %s:%d, %s/s\n", counter++, connection.hostname(), connection.port(), f(connection.getInputRate())));
+                               }
+                               writeLine("End of connections.");
+                               state = state.setLastConnections(lastConnections);
+                       } else if (words[0].equalsIgnoreCase("disconnect")) {
+                               if ((words.length == 1) || ("all".equals(words[1]))) {
+                                       for (Connection connection : state.getLastConnections()) {
+                                               core.closeConnection(connection);
+                                       }
+                               } else {
+                                       Integer index = Ints.tryParse(words[1]);
+                                       if ((index != null) && (index < state.getLastConnections().size())) {
+                                               core.closeConnection(state.getLastConnections().get(index));
+                                       }
+                               }
                        }
 
                        lastLine = line;
@@ -169,7 +218,7 @@ public class CommandReader extends AbstractExecutionThreadService {
        public void downloadStarted(DownloadStarted downloadStarted) {
                Download download = downloadStarted.download();
                try {
-                       writeLine(String.format("Download of %s (from %s, %s) has started.", download.filename(), download.bot().name(), download.bot().network().name()));
+                       writeLine(String.format("Download of %s (from %s, %s) has started.", download.pack().name(), download.bot().name(), download.bot().network().name()));
                } catch (IOException ioe1) {
                        /* ignore. */
                }
@@ -185,7 +234,7 @@ public class CommandReader extends AbstractExecutionThreadService {
        public void downloadFinished(DownloadFinished downloadFinished) {
                Download download = downloadFinished.download();
                try {
-                       writeLine(String.format("Download of %s (from %s, %s) has finished, at %s/s.", download.filename(), download.bot().name(), download.bot().network().name(), f(download.dccReceiver().overallRate())));
+                       writeLine(String.format("Download of %s (from %s, %s) has finished, at %s/s.", download.pack().name(), download.bot().name(), download.bot().network().name(), f(download.dccReceiver().overallRate())));
                } catch (IOException ioe1) {
                        /* ignore. */
                }
@@ -207,23 +256,40 @@ public class CommandReader extends AbstractExecutionThreadService {
                }
        }
 
-       //
-       // PRIVATE METHODS
-       //
+       /**
+        * Displays the received message on the console.
+        *
+        * @param messageReceived
+        *              The message received event
+        */
+       @Subscribe
+       public void messageReceived(MessageReceived messageReceived) {
+               try {
+                       writeLine(String.format("Message from %s: %s", messageReceived.source(), MessageCleaner.getDefaultInstance().clean(messageReceived.message())));
+               } catch (IOException e) {
+                       /* ignore. */
+               }
+       }
 
        /**
-        * Writes the given text to the {@link #writer}.
+        * Writes a generic message to the console.
         *
-        * @param text
-        *              The text to write
-        * @throws IOException
-        *              if an I/O error occurs
+        * @param genericMessage
+        *              The generic message event
         */
-       private void write(String text) throws IOException {
-               writer.write(text);
-               writer.flush();
+       @Subscribe
+       public void genericMessage(GenericMessage genericMessage) {
+               try {
+                       writeLine(genericMessage.message());
+               } catch (IOException ioe1) {
+                       /* ignore. */
+               }
        }
 
+       //
+       // PRIVATE METHODS
+       //
+
        /**
         * Writes the given line followed by an LF to the {@link #writer}.
         *
@@ -258,9 +324,108 @@ public class CommandReader extends AbstractExecutionThreadService {
                return String.format("%dB", number);
        }
 
+       /**
+        * Returns the estimated time left for the given transfer.
+        *
+        * @param dccReceiver
+        *              The DCC receiver to get the time left for
+        * @return The time left for the transfer, or “unknown” if the time can not be
+        *         estimated
+        */
+       private static String getTimeLeft(DccReceiver dccReceiver) {
+               if ((dccReceiver.size() == -1) || (dccReceiver.currentRate() == 0)) {
+                       return "unknown";
+               }
+               long secondsLeft = (dccReceiver.size() - dccReceiver.progress()) / dccReceiver.currentRate();
+               if (secondsLeft > 3600) {
+                       return String.format("%02d:%02d:%02d", secondsLeft / 3600, (secondsLeft / 60) % 60, secondsLeft % 60);
+               }
+               return String.format("%02d:%02d", (secondsLeft / 60) % 60, secondsLeft % 60);
+       }
+
        /** Container for result information. */
        private static class Result implements Comparable<Result> {
 
+               /** {@link Predicate} that matches {@link Result}s that contain an archive. */
+               private static final Predicate<Result> isArchive = new Predicate<Result>() {
+
+                       /** All suffixes that are recognized as archives. */
+                       private final List<String> archiveSuffixes = Arrays.asList("rar", "tar", "zip", "tar.gz", "tar.bz2", "tar.lzma", "7z");
+
+                       @Override
+                       public boolean apply(Result result) {
+                               for (String suffix : archiveSuffixes) {
+                                       if (result.pack().name().toLowerCase().endsWith(suffix)) {
+                                               return true;
+                                       }
+                               }
+                               return false;
+                       }
+               };
+
+               /**
+                * {@link Comparator} for {@link Result}s that sorts archives (as per {@link
+                * #isArchive} to the back of the list.
+                */
+               private static final Comparator<Result> packArchiveComparator = new Comparator<Result>() {
+                       @Override
+                       public int compare(Result leftResult, Result rightResult) {
+                               if (isArchive.apply(leftResult) && !isArchive.apply(rightResult)) {
+                                       return 1;
+                               }
+                               if (!isArchive.apply(leftResult) && isArchive.apply(rightResult)) {
+                                       return -1;
+                               }
+                               return 0;
+                       }
+               };
+
+               /**
+                * {@link Comparator} for bot nicknames. It comprises different strategies:
+                * one name pattern is preferred (and thus listed first), one pattern is
+                * disliked (and thus listed last), the rest is sorted alphabetically.
+                */
+               private static final Comparator<Result> botNameComparator = new Comparator<Result>() {
+
+                       /** Regular expression pattern for preferred names. */
+                       private final Pattern preferredNames = Pattern.compile("(?i)[^\\w]EUR?[^\\w]");
+
+                       /** Regular expression pattern for disliked names. */
+                       private final Pattern dislikedNames = Pattern.compile("(?i)[^\\w]USA?[^\\w]");
+
+                       @Override
+                       public int compare(Result leftResult, Result rightResult) {
+                               String leftBotName = leftResult.bot().name();
+                               String rightBotName = rightResult.bot().name();
+                               /* preferred names to the front! */
+                               if (preferredNames.matcher(leftBotName).find() && !preferredNames.matcher(rightBotName).find()) {
+                                       return -1;
+                               }
+                               if (preferredNames.matcher(rightBotName).find() && !preferredNames.matcher(leftBotName).find()) {
+                                       return 1;
+                               }
+                               /* disliked names to the back. */
+                               if (dislikedNames.matcher(leftBotName).find() && !dislikedNames.matcher(rightBotName).find()) {
+                                       return 1;
+                               }
+                               if (dislikedNames.matcher(rightBotName).find() && !dislikedNames.matcher(leftBotName).find()) {
+                                       return -1;
+                               }
+                               return 0;
+                       }
+               };
+
+               /**
+                * {@link Comparator} for {@link Result}s that sorts them by the name of the
+                * {@link Pack}.
+                */
+               private static final Comparator<Result> packNameComparator = new Comparator<Result>() {
+                       @Override
+                       public int compare(Result leftResult, Result rightResult) {
+                               return leftResult.pack().name().compareToIgnoreCase(rightResult.pack().name());
+                       }
+               };
+
                /** The bot carrying the pack. */
                private final Bot bot;
 
@@ -308,7 +473,120 @@ public class CommandReader extends AbstractExecutionThreadService {
 
                @Override
                public int compareTo(Result result) {
-                       return pack().name().compareToIgnoreCase(result.pack().name());
+                       return ComparisonChain.start()
+                                       .compare(this, result, packArchiveComparator)
+                                       .compare(this, result, botNameComparator)
+                                       .compare(this, result, packNameComparator).result();
+               }
+
+       }
+
+       /**
+        * Container for the current state of the command reader.
+        *
+        * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+        */
+       private static class State {
+
+               /** The last connections displayed. */
+               private final List<Connection> lastConnections;
+
+               /** The last results displayed. */
+               private final List<Result> lastResults;
+
+               /** The last downloads displayed. */
+               private final List<Download> lastDownloads;
+
+               /** Creates a new empty state. */
+               public State() {
+                       this(Lists.<Connection>newArrayList(), Lists.<Result>newArrayList(), Lists.<Download>newArrayList());
+               }
+
+               /**
+                * Creates a new state.
+                *
+                * @param lastConnections
+                *              The last connections
+                * @param lastResults
+                *              The last results
+                * @param lastDownloads
+                *              The last downloads
+                */
+               private State(List<Connection> lastConnections, List<Result> lastResults, List<Download> lastDownloads) {
+                       this.lastConnections = lastConnections;
+                       this.lastResults = lastResults;
+                       this.lastDownloads = lastDownloads;
+               }
+
+               //
+               // ACCESSORS
+               //
+
+               /**
+                * Returns the last connections displayed.
+                *
+                * @return The last connections displayed
+                */
+               public List<Connection> getLastConnections() {
+                       return lastConnections;
+               }
+
+               /**
+                * Returns the last results displayed.
+                *
+                * @return The last results displayed
+                */
+               public List<Result> getLastResults() {
+                       return lastResults;
+               }
+
+               /**
+                * Returns the last downloads displayed.
+                *
+                * @return The last downloads displayed
+                */
+               public List<Download> getLastDownloads() {
+                       return lastDownloads;
+               }
+
+               //
+               // MUTATORS
+               //
+
+               /**
+                * Returns a new state with the given last connections and the last downloads
+                * and results of this state.
+                *
+                * @param lastConnections
+                *              The new last connections displayed
+                * @return The new state
+                */
+               public State setLastConnections(List<Connection> lastConnections) {
+                       return new State(lastConnections, lastResults, lastDownloads);
+               }
+
+               /**
+                * Returns a new state with the given last results and the last downloads and
+                * connections of this state.
+                *
+                * @param lastResults
+                *              The new last results displayed
+                * @return The new state
+                */
+               public State setLastResults(List<Result> lastResults) {
+                       return new State(lastConnections, lastResults, lastDownloads);
+               }
+
+               /**
+                * Returns a new state with the given last downloads and the last connections
+                * and results of this state.
+                *
+                * @param lastDownloads
+                *              The new last downloads displayed
+                * @return The new state
+                */
+               public State setLastDownloads(List<Download> lastDownloads) {
+                       return new State(lastConnections, lastResults, lastDownloads);
                }
 
        }