src/main/java/net/pterodactylus/xdcc/ui/stdin/CommandReader.java

   1 /*
   2  * XdccDownloader - CommandReader.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.xdcc.ui.stdin;
  19
  20 import static com.google.common.collect.FluentIterable.from;
  21 import static java.util.Arrays.asList;
  22 import static net.pterodactylus.xdcc.ui.stdin.Ansi.bold;
  23 import static net.pterodactylus.xdcc.ui.stdin.Ansi.green;
  24 import static net.pterodactylus.xdcc.ui.stdin.Ansi.red;
  25 import static net.pterodactylus.xdcc.ui.stdin.Command.TO_NAME;
  26
  27 import java.io.BufferedReader;
  28 import java.io.IOException;
  29 import java.io.Reader;
  30 import java.io.Writer;
  31 import java.util.Collection;
  32 import java.util.List;
  33
  34 import net.pterodactylus.irc.util.MessageCleaner;
  35 import net.pterodactylus.xdcc.core.Core;
  36 import net.pterodactylus.xdcc.core.event.DownloadFailed;
  37 import net.pterodactylus.xdcc.core.event.DownloadFinished;
  38 import net.pterodactylus.xdcc.core.event.DownloadStarted;
  39 import net.pterodactylus.xdcc.core.event.GenericMessage;
  40 import net.pterodactylus.xdcc.core.event.MessageReceived;
  41 import net.pterodactylus.xdcc.data.Download;
  42
  43 import com.google.common.base.Joiner;
  44 import com.google.common.base.Optional;
  45 import com.google.common.collect.ImmutableList;
  46 import com.google.common.collect.ImmutableSet;
  47 import com.google.common.eventbus.Subscribe;
  48 import com.google.common.util.concurrent.AbstractExecutionThreadService;
  49
  50 /**
  51  * Command interface for arbitrary {@link Reader}s.
  52  *
  53  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  54  */
  55 public class CommandReader extends AbstractExecutionThreadService {
  56
  57         /** The commands to process. */
  58         private final Collection<Command> commands;
  59
  60         /** The reader to read commands from. */
  61         private final BufferedReader reader;
  62
  63         /** The writer to write the results to. */
  64         private final Writer writer;
  65         private final DownloadFailures downloadFailures;
  66
  67         /**
  68          * Creates a new command reader.
  69          *
  70          * @param core
  71          *              The core being controlled
  72          * @param reader
  73          *              The reader to read commands from
  74          * @param writer
  75          *              The write to write results to
  76          */
  77         public CommandReader(Core core, Reader reader, Writer writer, DownloadFailures downloadFailures) {
  78                 this.reader = new BufferedReader(reader);
  79                 this.writer = writer;
  80                 this.downloadFailures = downloadFailures;
  81
  82                 /* initialize commands. */
  83                 ImmutableList.Builder<Command> commandBuilder = ImmutableList.builder();
  84                 commandBuilder.add(new ListDownloadsCommand(core));
  85                 commandBuilder.add(new SearchCommand(core));
  86                 commandBuilder.add(new DownloadCommand(core));
  87                 commandBuilder.add(new StatsCommand(core));
  88                 commandBuilder.add(new ListConnectionsCommand(core));
  89                 commandBuilder.add(new AbortDownloadCommand(core));
  90                 commandBuilder.add(new DisconnectCommand(core));
  91                 commandBuilder.add(new FailedDownloadsCommand(downloadFailures));
  92                 commandBuilder.add(new RestartCommand(core, downloadFailures));
  93                 commandBuilder.add(new ResearchCommand(core));
  94                 commands = commandBuilder.build();
  95         }
  96
  97         //
  98         // ABSTRACTEXECUTIONTHREADSERVICE METHODS
  99         //
 100
 101         @Override
 102         protected void run() throws Exception {
 103                 String lastLine = "";
 104                 String line;
 105                 net.pterodactylus.xdcc.ui.stdin.State state = new net.pterodactylus.xdcc.ui.stdin.State();
 106                 while ((line = reader.readLine()) != null) {
 107                         line = line.trim();
 108                         if (line.equals("")) {
 109                                 line = lastLine;
 110                         }
 111                         String[] words = line.split(" +");
 112                         String commandName = words[0];
 113                         Collection<Command> eligibleCommands = findEligibleCommands(commandName);
 114                         if (eligibleCommands.isEmpty()) {
 115                                 writeLine(String.format("Invalid command: %s, valid: %s.", commandName, Joiner.on(' ').join(from(commands).transform(TO_NAME))));
 116                         } else if (eligibleCommands.size() > 1) {
 117                                 writeLine(String.format("Commands: %s.", Joiner.on(' ').join(from(eligibleCommands).transform(TO_NAME))));
 118                         } else {
 119                                 Command command = eligibleCommands.iterator().next();
 120                                 List<String> parameters = from(asList(words)).skip(1).toList();
 121                                 state = command.execute(state, parameters, writer);
 122                         }
 123
 124                         lastLine = line;
 125                 }
 126         }
 127
 128         //
 129         // EVENT HANDLERS
 130         //
 131
 132         /**
 133          * Called when a download was started.
 134          *
 135          * @param downloadStarted
 136          *              The download started event
 137          */
 138         @Subscribe
 139         public void downloadStarted(DownloadStarted downloadStarted) {
 140                 Download download = downloadStarted.download();
 141                 try {
 142                         writeLine(String.format("Download of %s (from %s, %s) has started.", bold(download.pack().name()), download.bot().name(), download.bot().network().name()));
 143                 } catch (IOException ioe1) {
 144                         /* ignore. */
 145                 }
 146         }
 147
 148         /**
 149          * Called when a download is finished.
 150          *
 151          * @param downloadFinished
 152          *              The download finished event
 153          */
 154         @Subscribe
 155         public void downloadFinished(DownloadFinished downloadFinished) {
 156                 Download download = downloadFinished.download();
 157                 try {
 158                         writeLine(green(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()))));
 159                 } catch (IOException ioe1) {
 160                         /* ignore. */
 161                 }
 162         }
 163
 164         /**
 165          * Called when a download fails.
 166          *
 167          * @param downloadFailed
 168          *              The download failed event
 169          */
 170         @Subscribe
 171         public void downloadFailed(DownloadFailed downloadFailed) {
 172                 Download download = downloadFailed.download();
 173                 downloadFailures.addFailedDownload(download, System.currentTimeMillis());
 174                 try {
 175                         writeLine(red(String.format("Download of %s (from %s, %s) has failed at %.1f%% and %s/s.", download.filename(), download.bot().name(), download.bot().network().name(), download.dccReceiver().progress() * 100.0 / download.dccReceiver().size(), f(download.dccReceiver().overallRate()))));
 176                 } catch (IOException ioe1) {
 177                         /* ignore. */
 178                 }
 179         }
 180
 181         /**
 182          * Displays the received message on the console.
 183          *
 184          * @param messageReceived
 185          *              The message received event
 186          */
 187         @Subscribe
 188         public void messageReceived(MessageReceived messageReceived) {
 189                 try {
 190                         writeLine(String.format("Message from %s: %s", messageReceived.source(), MessageCleaner.getDefaultInstance().clean(messageReceived.message())));
 191                 } catch (IOException e) {
 192                         /* ignore. */
 193                 }
 194         }
 195
 196         /**
 197          * Writes a generic message to the console.
 198          *
 199          * @param genericMessage
 200          *              The generic message event
 201          */
 202         @Subscribe
 203         public void genericMessage(GenericMessage genericMessage) {
 204                 try {
 205                         writeLine(genericMessage.message());
 206                 } catch (IOException ioe1) {
 207                         /* ignore. */
 208                 }
 209         }
 210
 211         //
 212         // PRIVATE METHODS
 213         //
 214
 215         private Collection<Command> findEligibleCommands(String name) {
 216                 ImmutableSet.Builder<Command> eligibleCommands = ImmutableSet.builder();
 217                 for (Command command : commands) {
 218                         if (command.getName().toLowerCase().startsWith(name.toLowerCase())) {
 219                                 eligibleCommands.add(command);
 220                         }
 221                         for (String alias : command.getAliases()) {
 222                                 if (alias.toLowerCase().startsWith(name.toLowerCase())) {
 223                                         eligibleCommands.add(command);
 224                                 }
 225                         }
 226                 }
 227                 return eligibleCommands.build();
 228         }
 229
 230         /**
 231          * Writes the given line followed by an LF to the {@link #writer}.
 232          *
 233          * @param line
 234          *              The line to write
 235          * @throws IOException
 236          *              if an I/O error occurs
 237          */
 238         private void writeLine(String line) throws IOException {
 239                 writer.write(line + "\n");
 240                 writer.flush();
 241         }
 242
 243         /**
 244          * Converts large numbers into a human-friendly format, by showing SI prefixes
 245          * for ×1024 (K), ×1048576 (M), and ×1073741824 (G).
 246          *
 247          * @param number
 248          *              The number to convert
 249          * @return The converted number
 250          */
 251         static String f(long number) {
 252                 if (number >= (1 << 30)) {
 253                         return String.format("%.1fG", number / (double) (1 << 30));
 254                 }
 255                 if (number >= (1 << 20)) {
 256                         return String.format("%.1fM", number / (double) (1 << 20));
 257                 }
 258                 if (number >= (1 << 10)) {
 259                         return String.format("%.1fK", number / (double) (1 << 10));
 260                 }
 261                 return String.format("%dB", number);
 262         }
 263
 264         /**
 265          * Formats the given number of seconds into a more easily readable string.
 266          *
 267          * @param seconds
 268          *              The number of seconds
 269          * @return The formatted time, or “unknown” if the time is unknown
 270          */
 271         static String t(Optional<Long> seconds) {
 272                 if (!seconds.isPresent()) {
 273                         return "unknown";
 274                 }
 275                 if (seconds.get() > 3600) {
 276                         return String.format("%02d:%02d:%02d", seconds.get() / 3600, (seconds.get() / 60) % 60, seconds.get() % 60);
 277                 }
 278                 return String.format("%02d:%02d", (seconds.get() / 60) % 60, seconds.get() % 60);
 279         }
 280
 281 }