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