Disable logging in if already logged in

Also refactored logging in and added notification for untraced "no oauth token" problem which occurs sometimes when logging in
Must be logged in to run config
Add prompt for sending analytics

Author: Irene

docs/MANUAL.md

@@ -206,6 +206,8 @@ List of configurable settings:
   blue, purple, cyan, white, none. Stored in properties.
 * *send-diagnostics*
   Allow sending crash reports and analytics for client development. Stored with account.
+* *send-analytics*
+  Allow sending analytics data of commands run. Stored in account.
 * *server-address*
   Address to fetch courses from and submit to. Defaults to `https://tmc.mooc.fi`. Stored with account
 

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

@@ -1,7 +1,6 @@
 package fi.helsinki.cs.tmc.cli;
 
 import fi.helsinki.cs.tmc.cli.analytics.AnalyticsFacade;
-import fi.helsinki.cs.tmc.cli.analytics.AnalyticsSettings;
 import fi.helsinki.cs.tmc.cli.analytics.TimeTracker;
 import fi.helsinki.cs.tmc.cli.backend.Settings;
 import fi.helsinki.cs.tmc.cli.command.SubmitCommand;
@@ -205,9 +204,8 @@ public static void main(String[] args) {
         Settings settings = new Settings();
         TaskExecutor tmcLangs = new TaskExecutorImpl();
         TmcCore core = new TmcCore(settings, tmcLangs);
-        AnalyticsSettings analyticsSettings = new AnalyticsSettings();
-        EventSendBuffer eventSendBuffer = new EventSendBuffer(analyticsSettings, new EventStore());
-        AnalyticsFacade analyticsFacade = new AnalyticsFacade(analyticsSettings, eventSendBuffer);
+        EventSendBuffer eventSendBuffer = new EventSendBuffer(settings, new EventStore());
+        AnalyticsFacade analyticsFacade = new AnalyticsFacade(settings, eventSendBuffer);
         Application app = new Application(new CliContext(null, core, new WorkDir(), settings, analyticsFacade));
         app.run(args);
     }

src/main/java/fi/helsinki/cs/tmc/cli/analytics/AnalyticsFacade.java

@@ -7,6 +7,7 @@
 import fi.helsinki.cs.tmc.spyware.EventSendBuffer;
 import fi.helsinki.cs.tmc.spyware.EventStore;
 import fi.helsinki.cs.tmc.spyware.LoggableEvent;
+import fi.helsinki.cs.tmc.spyware.SpywareSettings;
 
 import java.awt.*;
 import java.util.List;
@@ -16,10 +17,10 @@
 
 public class AnalyticsFacade {
     private EventSendBuffer eventSendBuffer;
-    private AnalyticsSettings settings;
+    private SpywareSettings settings;
     private static final Logger log = Logger.getLogger(AnalyticsFacade.class.getName());
 
-    public AnalyticsFacade(AnalyticsSettings settings, EventSendBuffer eventSendBuffer) {
+    public AnalyticsFacade(SpywareSettings settings, EventSendBuffer eventSendBuffer) {
         this.settings = settings;
         this.eventSendBuffer = eventSendBuffer;
     }

src/main/java/fi/helsinki/cs/tmc/cli/analytics/AnalyticsSettings.java

@@ -21,7 +21,11 @@ public void restart() {
     }
 
     public boolean anHourHasPassedSinceLastSubmit() {
-        long startTime = Long.parseLong(SettingsIo.loadProperties().get(PROPERTY_KEY));
+        String submitProperty = SettingsIo.loadProperties().get(PROPERTY_KEY);
+        if (submitProperty == null) {
+            return false;
+        }
+        long startTime = Long.parseLong(submitProperty);
         long endTime = System.nanoTime();
         long elapsedTime = endTime - startTime;
         long hoursPassed = TimeUnit.HOURS.convert(elapsedTime, TimeUnit.NANOSECONDS);

src/main/java/fi/helsinki/cs/tmc/cli/analytics/TimeTracker.java

@@ -19,6 +19,8 @@ public class Account {
     private String token;
     private Organization organization;
     private boolean sendDiagnostics;
+    private boolean sendAnalytics;
+    private boolean sendDetailedAnalytics;
     private static final String DEFAULT_SERVER =  "https://tmc.mooc.fi/staging";
 
     // for gson
@@ -88,12 +90,12 @@ public void setPassword(Optional<String> password) {
         this.password = null;
     }
 
-    public Optional<String> getoAuthToken() {
-        return Optional.of(this.token);
+    public Optional<String> getOauthToken() {
+        return Optional.fromNullable(this.token);
     }
 
-    public void setoAuthToken(Optional<String> token) {
-        this.token= token.orNull();
+    public void setOauthToken(Optional<String> token) {
+        this.token = token.orNull();
     }
 
     public Optional<Course> getCurrentCourse() {
@@ -119,4 +121,20 @@ public void setSendDiagnostics(boolean value) {
     public boolean getSendDiagnostics() {
         return this.sendDiagnostics;
     }
+
+    public boolean getSendAnalytics() {
+        return this.sendAnalytics;
+    }
+
+    public void setSendAnalytics(boolean sendAnalytics) {
+        this.sendAnalytics = sendAnalytics;
+    }
+
+    public boolean getSendDetailedAnalytics() {
+        return false;
+    }
+
+    public void setSendDetailedAnalytics(boolean sendDetailedAnalytics) {
+        this.sendDetailedAnalytics = false;
+    }
 }

src/main/java/fi/helsinki/cs/tmc/cli/backend/Account.java

@@ -9,12 +9,13 @@
 import com.google.common.base.Optional;
 import fi.helsinki.cs.tmc.core.domain.OauthCredentials;
 import fi.helsinki.cs.tmc.core.domain.Organization;
+import fi.helsinki.cs.tmc.spyware.SpywareSettings;
 import org.apache.http.impl.conn.SystemDefaultRoutePlanner;
 
 import java.nio.file.Path;
 import java.util.Locale;
 
-public class Settings implements TmcSettings {
+public class Settings implements TmcSettings, SpywareSettings {
 
     private WorkDir workDir;
     private Account account;
@@ -148,12 +149,12 @@ public void setOauthCredentials(Optional<OauthCredentials> credentials) {
 
     @Override
     public void setToken(Optional<String> token) {
-        account.setoAuthToken(token);
+        account.setOauthToken(token);
     }
 
     @Override
     public Optional<String> getToken() {
-        return account.getoAuthToken();
+        return account.getOauthToken();
     }
 
     @Override
@@ -166,7 +167,21 @@ public void setOrganization(Optional<Organization> organization) {
         account.setOrganization(organization);
     }
 
-    public void setCourse(Course course) {
-        account.setCurrentCourse(Optional.of(course));
+    @Override
+    public boolean isSpywareEnabled() {
+        return account.getSendAnalytics();
+    }
+
+    public void setSpywareEnabled(boolean spywareEnabled) {
+        account.setSendAnalytics(spywareEnabled);
+    }
+
+    @Override
+    public boolean isDetailedSpywareEnabled() {
+        return account.getSendDetailedAnalytics();
+    }
+
+    public void setDetailedSpywareEnabled(boolean detailedSpywareEnabled) {
+        account.setSendDetailedAnalytics(detailedSpywareEnabled);
     }
 }

src/main/java/fi/helsinki/cs/tmc/cli/backend/Settings.java

@@ -18,6 +18,7 @@
 
 import org.apache.commons.compress.archivers.sevenz.CLI;
 import org.apache.oltu.oauth2.common.exception.OAuthProblemException;
+import org.apache.oltu.oauth2.common.exception.OAuthSystemException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -236,7 +237,7 @@ private static void handleTmcExceptions(CliContext ctx, Exception exception) {
 
         if (exception instanceof IllegalArgumentException) {
             logger.error("Invalid arguments", exception);
-            io.errorln("Please give server, username and password in valid form.");
+            io.errorln("Please give server, username and password in valid forms.");
             return;
         }
 
@@ -259,11 +260,17 @@ private static void handleTmcExceptions(CliContext ctx, Exception exception) {
             return;
         }
 
+        if (cause instanceof OAuthSystemException) {
+            io.errorln("There was a problem with authentication.\nPlease try logging in again.");
+            return;
+        }
+
         if (cause != null && cause.getCause() instanceof UnknownHostException) {
             logger.error("No internet connection");
             io.errorln("You have no internet connection.");
             return;
         }
+
         logger.error("Command failed in tmc-core", exception);
         //TODO we seem to write twice error message; here and in the commands.
         io.errorln("Command failed, check tmc-cli.log file for more info");

src/main/java/fi/helsinki/cs/tmc/cli/backend/TmcUtil.java

@@ -1,5 +1,6 @@
 package fi.helsinki.cs.tmc.cli.command;
 
+import com.google.common.base.Optional;
 import fi.helsinki.cs.tmc.cli.backend.SettingsIo;
 import fi.helsinki.cs.tmc.cli.core.AbstractCommand;
 import fi.helsinki.cs.tmc.cli.core.CliContext;
@@ -17,10 +18,8 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Set;
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashSet;
-import java.util.Collections;
 
 @Command(name = "config", desc = "Set/unset TMC-CLI properties")
 public class ConfigCommand extends AbstractCommand {
@@ -43,15 +42,15 @@ private void configureAllowedKeys() {
         // add new possible config options here
         // each key has a BiConsumer function which validates the value and saves it in settings or properties
         ALLOWED_KEYS.put("send-diagnostics", (key, value) -> {
-            String newVal = (String) value;
-            if (!newVal.trim().toLowerCase().equals("true") && !newVal.trim().toLowerCase().equals("false")) {
-                throw new BadValueTypeException("Please write either true or false");
-            }
-            boolean send = Boolean.parseBoolean(newVal);
+            boolean send = getBooleanSendValue((String) value);
             context.getSettings().setSendDiagnostics(send);
             SettingsIo.saveCurrentSettingsToAccountList(context.getSettings());
         });
-
+        ALLOWED_KEYS.put("send-analytics", (key, value) -> {
+            boolean send = getBooleanSendValue((String) value);
+            context.getSettings().setSpywareEnabled(send);
+            SettingsIo.saveCurrentSettingsToAccountList(context.getSettings());
+        });
         ALLOWED_KEYS.put("server-address", (key, address) -> {
             String addr = (String) address;
             if (!addr.matches("^https?://.*")) {
@@ -64,18 +63,29 @@ private void configureAllowedKeys() {
             }
             SettingsIo.saveCurrentSettingsToAccountList(context.getSettings());
         });
-
         ALLOWED_KEYS.put("update-date", (key, value) -> {
             String date = (String) value;
             if (!date.matches("[0-9]+")) {
                 throw new BadValueTypeException("Please insert the date as a number");
             }
             properties.put("update-date", date);
         });
-        ALLOWED_KEYS.put("testresults-right", this::addToProperties);
-        ALLOWED_KEYS.put("testresults-left", this::addToProperties);
-        ALLOWED_KEYS.put("progressbar-left", this::addToProperties);
-        ALLOWED_KEYS.put("progressbar-right", this::addToProperties);
+        ALLOWED_KEYS.put("testresults-right", this::addBarColorToProperties);
+        ALLOWED_KEYS.put("testresults-left", this::addBarColorToProperties);
+        ALLOWED_KEYS.put("progressbar-left", this::addBarColorToProperties);
+        ALLOWED_KEYS.put("progressbar-right", this::addBarColorToProperties);
+    }
+
+    private boolean getBooleanSendValue(String value) throws BadValueTypeException {
+        String newVal = value;
+        isBooleanValue(newVal);
+        return Boolean.parseBoolean(newVal);
+    }
+
+    private void isBooleanValue(String newVal) throws BadValueTypeException {
+        if (!newVal.trim().toLowerCase().equals("true") && !newVal.trim().toLowerCase().equals("false")) {
+            throw new BadValueTypeException("Not a boolean value");
+        }
     }
 
     @Override
@@ -109,12 +119,13 @@ public void run(CliContext context, CommandLine args) {
         arguments = Arrays.stream(arguments).filter(o -> !o.trim().isEmpty()).toArray(String[]::new);
         this.properties = context.getProperties();
 
-        if (this.context.getSettings().getUsername().isPresent()) {
-            this.context.getAnalyticsFacade().saveAnalytics(this.context.getSettings().getUsername().get(), "config");
-        } else {
-            this.context.getAnalyticsFacade().saveAnalytics("config");
+        if (!this.context.checkIsLoggedIn(false)) {
+            return;
         }
 
+        Optional<String> username = this.context.getSettings().getUsername();
+        this.context.getAnalyticsFacade().saveAnalytics(username.isPresent() ? username.get() : "", "config");
+
         if ((get ? 1 : 0) + (listing ? 1 : 0) + (delete ? 1 : 0) > 1) {
             io.errorln("Only one of the --get or --list or --delete options can "
                     + "be used at same time.");
@@ -155,12 +166,12 @@ public void run(CliContext context, CommandLine args) {
     }
 
     private void printAllProperties() {
-        ArrayList<String> array = new ArrayList<>(properties.keySet());
-        Collections.sort(array);
+        // how to handle that some values are stored in settings and some in properties?
+        ALLOWED_KEYS.keySet().stream().sorted().forEach(k -> {
+            String property = properties.get(k);
+            io.println(k + "=" + (property != null ? property : "<not set>"));
+        });
 
-        for (String key : array) {
-            io.println(key + "=" + properties.get(key));
-        }
     }
 
     private void deleteProperties(String[] keys) {
@@ -256,13 +267,13 @@ private boolean checkIfAllowedKey(String key) {
         if (!ALLOWED_KEYS.keySet().contains(key)) {
             io.println("\"" + key + "\" is not an allowed key.");
             io.println("Allowed keys are: ");
-            ALLOWED_KEYS.keySet().stream().forEach(k -> io.print(" " + k + '\n'));
+            ALLOWED_KEYS.keySet().forEach(k -> io.print(" " + k + '\n'));
             return false;
         }
         return true;
     }
 
-    private void addToProperties(String key, Object value) throws BadValueTypeException {
+    private void addBarColorToProperties(String key, Object value) throws BadValueTypeException {
         String color = (String) value;
         if (!PROGRESS_BAR_COLORS.contains(color)) {
             throw new BadValueTypeException("Color " + value + " not supported.");

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

@@ -59,7 +59,7 @@ public void run(CliContext context, CommandLine args) {
         ctx = context;
         showAll = args.hasOption("a");
 
-        if (!ctx.checkIsLoggedIn()) {
+        if (!ctx.checkIsLoggedIn(false)) {
             return;
         }