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 DuplicateLineSuppressingWriter 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                 commandBuilder.add(new UptimeCommand(core));
  97                 commands = commandBuilder.build();
  98         }
  99
 100         //
 101         // ABSTRACTEXECUTIONTHREADSERVICE METHODS
 102         //
 103
 104         @Override
 105         protected void run() throws Exception {
 106                 String lastLine = "";
 107                 String line;
 108                 net.pterodactylus.xdcc.ui.stdin.State state = new net.pterodactylus.xdcc.ui.stdin.State();
 109                 while ((line = reader.readLine()) != null) {
 110                         line = line.trim();
 111                         if (line.equals("")) {
 112                                 line = lastLine;
 113                         }
 114                         writer.reset();
 115                         String[] words = line.split(" +");
 116                         String commandName = words[0];
 117                         Collection<Command> eligibleCommands = findEligibleCommands(commandName);
 118                         if (eligibleCommands.isEmpty()) {
 119                                 writeLine(String.format("Invalid command: %s, valid: %s.", commandName, Joiner.on(' ').join(from(commands).transform(TO_NAME))));
 120                         } else if (eligibleCommands.size() > 1) {
 121                                 writeLine(String.format("Commands: %s.", Joiner.on(' ').join(from(eligibleCommands).transform(TO_NAME))));
 122                         } else {
 123                                 Command command = eligibleCommands.iterator().next();
 124                                 List<String> parameters = from(asList(words)).skip(1).toList();
 125                                 state = command.execute(state, parameters, writer);
 126                                 writer.flush();
 127                         }
 128
 129                         lastLine = line;
 130                 }
 131         }
 132
 133         //
 134         // EVENT HANDLERS
 135         //
 136
 137         /**
 138          * Called when a download was started.
 139          *
 140          * @param downloadStarted
 141          *              The download started event
 142          */
 143         @Subscribe
 144         public void downloadStarted(DownloadStarted downloadStarted) {
 145                 Download download = downloadStarted.download();
 146                 try {
 147                         writeLine(String.format("Download of %s (from %s, %s) has started.", bold(download.pack().name()), download.bot().name(), download.bot().network().name()));
 148                 } catch (IOException ioe1) {
 149                         /* ignore. */
 150                 }
 151         }
 152
 153         /**
 154          * Called when a download is finished.
 155          *
 156          * @param downloadFinished
 157          *              The download finished event
 158          */
 159         @Subscribe
 160         public void downloadFinished(DownloadFinished downloadFinished) {
 161                 Download download = downloadFinished.download();
 162                 removeFailedDownloads(download.pack().name());
 163                 try {
 164                         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()))));
 165                 } catch (IOException ioe1) {
 166                         /* ignore. */
 167                 }
 168         }
 169
 170         private void removeFailedDownloads(String name) {
 171                 List<Download> failedDownloadsToRemove = new ArrayList<>();
 172                 for (Download failedDownload : failedDownloads) {
 173                         if (failedDownload.pack().name().equals(name)) {
 174                                 failedDownloadsToRemove.add(failedDownload);
 175                         }
 176                 }
 177                 failedDownloads.removeAll(failedDownloadsToRemove);
 178         }
 179
 180         /**
 181          * Called when a download fails.
 182          *
 183          * @param downloadFailed
 184          *              The download failed event
 185          */
 186         @Subscribe
 187         public void downloadFailed(DownloadFailed downloadFailed) {
 188                 Download download = downloadFailed.download();
 189                 failedDownloads.add(download);
 190                 try {
 191                         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()))));
 192                 } catch (IOException ioe1) {
 193                         /* ignore. */
 194                 }
 195         }
 196
 197         /**
 198          * Displays the received message on the console.
 199          *
 200          * @param messageReceived
 201          *              The message received event
 202          */
 203         @Subscribe
 204         public void messageReceived(MessageReceived messageReceived) {
 205                 try {
 206                         writeLine(String.format("Message from %s: %s", messageReceived.source(), MessageCleaner.getDefaultInstance().clean(messageReceived.message())));
 207                 } catch (IOException e) {
 208                         /* ignore. */
 209                 }
 210         }
 211
 212         /**
 213          * Writes a generic message to the console.
 214          *
 215          * @param genericMessage
 216          *              The generic message event
 217          */
 218         @Subscribe
 219         public void genericMessage(GenericMessage genericMessage) {
 220                 try {
 221                         writeLine(genericMessage.message());
 222                 } catch (IOException ioe1) {
 223                         /* ignore. */
 224                 }
 225         }
 226
 227         //
 228         // PRIVATE METHODS
 229         //
 230
 231         private Collection<Command> findEligibleCommands(String name) {
 232                 ImmutableSet.Builder<Command> eligibleCommands = ImmutableSet.builder();
 233                 for (Command command : commands) {
 234                         if (command.getName().toLowerCase().startsWith(name.toLowerCase())) {
 235                                 eligibleCommands.add(command);
 236                         }
 237                         for (String alias : command.getAliases()) {
 238                                 if (alias.toLowerCase().startsWith(name.toLowerCase())) {
 239                                         eligibleCommands.add(command);
 240                                 }
 241                         }
 242                 }
 243                 return eligibleCommands.build();
 244         }
 245
 246         /**
 247          * Writes the given line followed by an LF to the {@link #writer}.
 248          *
 249          * @param line
 250          *              The line to write
 251          * @throws IOException
 252          *              if an I/O error occurs
 253          */
 254         private void writeLine(String line) throws IOException {
 255                 writer.write(line + "\n");
 256                 writer.flush();
 257         }
 258
 259         /**
 260          * Converts large numbers into a human-friendly format, by showing SI prefixes
 261          * for ×1024 (K), ×1048576 (M), and ×1073741824 (G).
 262          *
 263          * @param number
 264          *              The number to convert
 265          * @return The converted number
 266          */
 267         static String f(long number) {
 268                 if (number >= (1 << 30)) {
 269                         return String.format("%.1fG", number / (double) (1 << 30));
 270                 }
 271                 if (number >= (1 << 20)) {
 272                         return String.format("%.1fM", number / (double) (1 << 20));
 273                 }
 274                 if (number >= (1 << 10)) {
 275                         return String.format("%.1fK", number / (double) (1 << 10));
 276                 }
 277                 return String.format("%dB", number);
 278         }
 279
 280         /**
 281          * Formats the given number of seconds into a more easily readable string.
 282          *
 283          * @param seconds
 284          *              The number of seconds
 285          * @return The formatted time, or “unknown” if the time is unknown
 286          */
 287         static String t(Optional<Long> seconds) {
 288                 if (!seconds.isPresent()) {
 289                         return "unknown";
 290                 }
 291                 if (seconds.get() > 3600) {
 292                         return String.format("%02d:%02d:%02d", seconds.get() / 3600, (seconds.get() / 60) % 60, seconds.get() % 60);
 293                 }
 294                 return String.format("%02d:%02d", (seconds.get() / 60) % 60, seconds.get() % 60);
 295         }
 296
 297 }