Merge branch 'master' into new-update-command-juha

Author: juvester

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>fi.helsinki.cs.tmc.cli</groupId>
     <artifactId>tmc-cli</artifactId>
-    <version>0.4.2</version>
+    <version>0.5.0</version>
     <packaging>jar</packaging>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

scripts/autocompletion.sh

@@ -3,7 +3,7 @@
 # SCRIPT_PATH will be filled by stub script
 alias tmc="$SCRIPT_PATH/tmc"
 
-tmcCommands=\$(tmc shell-helpper -c)
+tmcCommands=\$(tmc shell-helper -c)
 
 _tmc_opts()
 {

src/main/java/fi/helsinki/cs/tmc/cli/Application.java

@@ -29,6 +29,7 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Arrays;
+import java.util.Date;
 import java.util.HashMap;
 import java.util.Properties;
 
@@ -39,12 +40,18 @@
  */
 public class Application {
     private static final Logger logger = LoggerFactory.getLogger(Application.class);
+    private static final String previousUpdateDateKey = "update-date";
+    private static final long defaultUpdateInterval = 60 * 60 * 1000;
+
     private CommandFactory commandFactory;
+    private HashMap<String, String> properties;
     private TmcCore tmcCore;
     private Settings settings;
-    private Io io;
     private WorkDir workDir;
-    private HashMap<String, String> properties;
+    private Io io;
+
+    private boolean inTest;
+    private ShutdownHandler shutdownHandler;
 
     private Options options;
     private GnuParser parser;
@@ -55,6 +62,15 @@ public Application(Io io) {
         this.commandFactory = new CommandFactory();
         options.addOption("h", "help", false, "Display help information about tmc-cli");
         options.addOption("v", "version", false, "Give the version of the tmc-cli");
+
+        inTest = true;
+        if (io == null) {
+            inTest = false;
+            io = new TerminalIo();
+            shutdownHandler = new ShutdownHandler(io);
+            Runtime.getRuntime().addShutdownHook(shutdownHandler);
+        }
+
         this.io = io;
         this.workDir = new WorkDir();
         this.properties = SettingsIo.loadProperties();
@@ -119,12 +135,15 @@ public void printHelp() {
     }
 
     public void run(String[] args) {
+        if (!inTest) {
+            versionCheck();
+        }
+
         String[] tmcArgs;
         String[] commandArgs;
         String commandName;
-        int commandIndex;
 
-        commandIndex = findCommand(args);
+        int commandIndex = findCommand(args);
 
         if (commandIndex != -1) {
             commandName = args[commandIndex];
@@ -133,7 +152,6 @@ public void run(String[] args) {
             tmcArgs = Arrays.copyOfRange(args, 0, commandIndex);
             commandArgs = Arrays.copyOfRange(args, commandIndex + 1, args.length);
 
-
         } else {
             commandName = "help";
             tmcArgs = args;
@@ -145,6 +163,10 @@ public void run(String[] args) {
         }
 
         runCommand(commandName, commandArgs);
+
+        if (!inTest) {
+            Runtime.getRuntime().removeShutdownHook(shutdownHandler);
+        }
     }
 
     public void createTmcCore(Settings settings) {
@@ -207,15 +229,8 @@ public void setSettings(Settings settings) {
     }
 
     public static void main(String[] args) {
-        Io io = new TerminalIo();
-        ShutdownHandler shutdownHandler = new ShutdownHandler(io);
-        Runtime.getRuntime().addShutdownHook(shutdownHandler);
-
-        new TmcCliUpdater(io, getVersion(), isWindows()).run();
-
-        Application app = new Application(io);
+        Application app = new Application(null);
         app.run(args);
-        Runtime.getRuntime().removeShutdownHook(shutdownHandler);
     }
 
     public static String getVersion() {
@@ -263,4 +278,33 @@ public static boolean isWindows() {
     public CourseInfo createCourseInfo(Course course) {
         return new CourseInfo(settings, course);
     }
+
+    private void versionCheck() {
+        String previousTimestamp = properties.get(previousUpdateDateKey);
+        Date previous = null;
+
+        if (previousTimestamp != null) {
+            long time;
+            try {
+                time = Long.parseLong(previousTimestamp);
+            } catch (NumberFormatException ex) {
+                io.println("The previous update date isn't number.");
+                logger.warn("The previous update date isn't number.", ex);
+                return;
+            }
+            previous = new Date(time);
+        }
+
+        Date now = new Date();
+        if (previous != null && previous.getTime() + defaultUpdateInterval > now.getTime()) {
+            return;
+        }
+
+        TmcCliUpdater update = new TmcCliUpdater(io, getVersion(), isWindows());
+        update.run();
+
+        long timestamp = now.getTime();
+        properties.put(previousUpdateDateKey, Long.toString(timestamp));
+        setProperties(properties);
+    }
 }

src/main/java/fi/helsinki/cs/tmc/cli/command/HelpCommand.java

@@ -47,14 +47,17 @@ private List<String> getCommandStrings() {
             if ((Class)commandClass == (Class)TestCommand.class) {
                 continue;
             }
+            if ((Class)commandClass == (Class)ShellHelperCommand.class) {
+                continue;
+            }
             strings.add(createCommandString(command));
         }
         return strings;
     }
 
     private String createCommandString(Command command) {
         StringBuilder builder = new StringBuilder();
-        builder.append("  " + command.name());
+        builder.append("  ").append(command.name());
         for (int i = 0; i < longestName - command.name().length() + 2; i++) {
             builder.append(" ");
         }

…tmc/cli/command/ShellHelpperCommand.java …/tmc/cli/command/ShellHelperCommand.javasrc/main/java/fi/helsinki/cs/tmc/cli/command/ShellHelpperCommand.java renamed to src/main/java/fi/helsinki/cs/tmc/cli/command/ShellHelperCommand.java src/main/java/fi/helsinki/cs/tmc/cli/command/ShellHelpperCommand.java renamed to src/main/java/fi/helsinki/cs/tmc/cli/command/ShellHelperCommand.java

@@ -8,8 +8,8 @@
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Options;
 
-@Command(name = "shell-helpper", desc = "Submit exercises")
-public class ShellHelpperCommand extends AbstractCommand {
+@Command(name = "shell-helper", desc = "Used by autocomplete to extract internal values.")
+public class ShellHelperCommand extends AbstractCommand {
 
     @Override
     public void getOptions(Options options) {
@@ -25,6 +25,8 @@ public void run(CommandLine args, Io io) {
                 Command command = CommandFactory.getCommand(commandClass);
                 io.println(command.name());
             }
+        } else {
+            io.println("This is only for internal usage.");
         }
     }
 

src/main/java/fi/helsinki/cs/tmc/cli/updater/TmcCliUpdater.java

@@ -21,6 +21,7 @@
 import java.io.File;
 import java.io.InputStream;
 import java.io.IOException;
+import java.util.logging.Level;
 
 public class TmcCliUpdater {
 
@@ -87,38 +88,47 @@ public void run() {
         runNewTmcCliBinary(destination.getAbsolutePath());
     }
 
-    protected InputStream fetchHttpEntity(String url) {
+    protected byte[] fetchHttpEntity(String url) {
         CloseableHttpClient httpClient = HttpClients.createDefault();
         HttpGet httpGet = new HttpGet(url);
         httpGet.addHeader("User-Agent", "tmc-cli (https://github.com/tmc-cli/tmc-cli)");
 
-        InputStream stream = null;
+        HttpEntity entity;
+        byte[] content;
         try {
             CloseableHttpResponse httpResponse = httpClient.execute(httpGet);
-            HttpEntity entity = httpResponse.getEntity();
-            if (entity != null) {
-                stream = entity.getContent();
+            entity = httpResponse.getEntity();
+            if (entity == null) {
+                logger.warn("Failed to get http request content.");
+                httpGet.releaseConnection();
+                return null;
             }
 
         } catch (IOException ex) {
             logger.warn("Failed to create http connection to github.", ex);
+            return null;
+        }
+        try {
+            content = IOUtils.toByteArray(entity.getContent());
+        } catch (IOException ex) {
+            logger.warn("Failed to fetch data from github", ex);
+            content = null;
         }
-
         httpGet.releaseConnection();
-        return stream;
+        return content;
     }
 
     /**
      * Downloads a JSON string that contains information about the latest
      * tmc-cli release.
      */
     protected String fetchLatestReleaseJson() {
-        InputStream stream = fetchHttpEntity(LATEST_RELEASE_URL);
-        if (stream == null) {
+        byte[] content = fetchHttpEntity(LATEST_RELEASE_URL);
+        if (content == null) {
             return null;
         }
         try {
-            return IOUtils.toString(stream, "UTF-8");
+            return new String(content, "UTF-8");
         } catch (IOException ex) {
             logger.warn("Failed to fetch JSON data for the latest release", ex);
         }
@@ -130,13 +140,13 @@ protected String fetchLatestReleaseJson() {
      * file.
      */
     protected void fetchTmcCliBinary(String downloadUrl, File destination) {
-        InputStream stream = fetchHttpEntity(downloadUrl);
-        if (stream == null) {
+        byte[] content = fetchHttpEntity(downloadUrl);
+        if (content == null) {
             io.println("Failed to download tmc-cli.");
             return;
         }
         try {
-            FileUtils.copyInputStreamToFile(stream, destination);
+            FileUtils.writeByteArrayToFile(destination, content);
         } catch (IOException ex) {
             io.println("Failed to write the new version into \'" + destination + "\'.");
         }