summaryrefslogtreecommitdiff
path: root/src/main/TweetShell.java
blob: d292c9a4a4aaeb8f9676af01955f64cf09ae6b99 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
package main;

import io.CompressableDataWriter;
import io.DataWriter;
import io.OAuthRequester;
import io.StreamImpl;
import java.io.Closeable;
import java.io.IOException;
import java.util.Arrays;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Scanner;
import java.util.Set;
import java.util.TreeMap;
import java.util.logging.Level;
import java.util.logging.Logger;
import mining.Stream;
import mining.TwitterApi;
import org.apache.commons.io.IOUtils;
import org.json.JSONException;
import org.json.JSONObject;
import provider.CompositeResultListener;
import provider.ExceptionListener;
import provider.ResultListener;
import support.ClassEnabledTracker;
import utils.Configuration;

/**
 * Provides an interactive shell where requests can be made and displayed.
 */
public class TweetShell implements TwitterApi.PinSupplier {

    private final Scanner scanner = new Scanner(System.in);

    private TwitterApi api_cached;
    private Stream stream_cached;
    private final CompositeResultListener resultListeners;

    public TweetShell() {
        resultListeners = new CompositeResultListener();
        // by default, store something that counts responses
        resultListeners.register(new TweetCounter());
        // and something that prints tweets to console.
        resultListeners.register(new StreamHandler());
        // see getPossibleTargets() for more listener types.
    }

    private TwitterApi getApi() throws IOException {
        if (api_cached == null) {
            api_cached = TwitterApi.getOAuth(this);
        }
        return api_cached;
    }

    private Stream getStream() throws IOException {
        if (stream_cached == null) {
            OAuthRequester requester = (OAuthRequester) getApi().getRequester();
            stream_cached = new StreamImpl(requester);
            StreamImpl streamObserver = (StreamImpl) stream_cached;
            streamObserver.setExceptionListener(new StreamExceptionHandler());
            streamObserver.setResultListener(resultListeners);
        }
        return stream_cached;
    }

    private class StreamExceptionHandler implements ExceptionListener {

        @Override
        public void exceptionGenerated(Exception ex) {
            System.err.println("Stream closed due to " + ex);
        }
    }

    private class StreamHandler implements ResultListener {

        @Override
        public void tweetGenerated(JSONObject obj) {
            try {
                System.out.println("Got tweet: " + obj.getString("text"));
            } catch (JSONException ex) {
                getLogger().log(Level.SEVERE, "Failed to parse tweet", ex);
            }
        }

        @Override
        public void profileGenerated(JSONObject obj) {
            try {
                System.out.println("Got user: " + obj.getString("name"));
            } catch (JSONException ex) {
                getLogger().log(Level.SEVERE, "Failed to parse user", ex);
            }
        }

        private Logger getLogger() {
            return Logger.getLogger(getClass().getName());
        }
    }

    @Override
    public String requestPin(String url) throws IOException {
        System.err.println(url);
        System.err.println("Please open the above URL and enter PIN:");
        return scanner.nextLine();
    }

    private void printPrompt() {
        if (stream_cached == null) {
            // "dollars are worthless"
            System.out.print("$ ");
        } else if (stream_cached.isValid()) {
            // "we make money now by receiving tweets"
            System.out.print("€ ");
        } else {
            // "we previously made money, but not anymore"
            System.out.print("ƒ ");
        }
    }

    /**
     * Processes commands from stdin until the exit command is received or EOF.
     */
    public void process_forever() {
        System.err.println("Entering interactive shell, type 'help' for help "
                + "or 'exit' to leave.");
        // print prompt for reading first command
        printPrompt();
        while (scanner.hasNextLine()) {
            String line = scanner.nextLine().trim();
            if (!execute(line)) {
                // requested to terminate
                break;
            }
            // print prompt for reading next line
            printPrompt();
        }
    }

    public boolean execute(String cmd) {
        String[] args = cmd.trim().split("\\s+", 2);
        if (!args[0].isEmpty()) {
            // non-empty command, let's see whether it makes sense?
            return execute(args);
        }
        return true;
    }

    /**
     * Executes a command with optional parameters.
     *
     * @param args An array with the first argument containing the command with
     * optional parameters in following arguments.
     * @return true if more commands are allowed to be executed, false
     * otherwise.
     */
    public boolean execute(String[] args) {
        try {
            Command command = Command.fromString(args[0]);
            String[] params = Arrays.copyOfRange(args, 1, args.length);
            execute(command, params);
        } catch (IllegalArgumentException ex) {
            System.err.println(ex.getMessage());
        } catch (IOException ex) {
            System.err.println("Command " + args[0] + " failed with " + ex);
            ex.printStackTrace();
        } catch (NoSuchElementException ex) {
            // thrown by the "exit" command to signal exit
            return false;
        }
        // another satisfied customer, next!
        return true;
    }

    enum Command {

        add("Adds a keyword to search", 1),
        del("Deletes a keyword from search", 1),
        keywords("Display currently active keywords"),
        commit("Activate the stream or apply the stream keyword changes"),
        status("Show some status and statistics"),
        close("Close the stream"),
        exit("Returns to shell"),
        help("Get help"),
        target("Show available and enabled targets (if no args are given). "
                + "If one or more args are given, change the output targets. "
                + "A '-' or '+' prefix only enables/disables that target. "
                + "With no prefix, all other targets get disabled.");

        private final String description;
        private final int paramCount;

        Command(String description) {
            this.description = description;
            this.paramCount = 0;
        }

        Command(String description, int paramCount) {
            this.description = description;
            this.paramCount = paramCount;
        }

        public String getDescription() {
            return description;
        }

        public int getParamCount() {
            return paramCount;
        }

        public static Command fromString(String command) {
            for (Command cmd : values()) {
                if (cmd.name().equals(command)) {
                    return cmd;
                }
            }
            throw new IllegalArgumentException("Unrecognized command. Hint: help");
        }
    };

    private final String[] HELP = new String[]{
        "Interactive TweetShell",
        "",
        "Available commands:"
    };

    private void execute(Command command, String[] params) throws IOException {
        if (params.length < command.getParamCount()) {
            throw new IllegalArgumentException("Expected "
                    + command.getParamCount() + " parameters, got only "
                    + params.length);
        }
        switch (command) {
            case add:
                getStream().watchKeyword(params[0]);
                break;
            case del:
                getStream().unwatchKeyword(params[0]);
                break;
            case keywords:
                Set<String> active = getStream().getKeywords(true);
                Set<String> queued = getStream().getKeywords(false);
                if (active.isEmpty() && queued.isEmpty()) {
                    System.out.println("No keywords found. Add some with 'add'");
                } else {
                    System.out.println("Keywords:");
                }
                for (String keyword : active) {
                    System.out.print("  \"" + keyword + "\"");
                    if (!queued.contains(keyword)) {
                        System.out.println(" (will be removed)");
                    } else {
                        System.out.println();
                    }
                }
                queued.removeAll(active);
                for (String keyword : queued) {
                    System.out.println("  \"" + keyword + "\" (will be added)");
                }
                if (!queued.equals(active)) {
                    System.out.println("To apply changes, run 'commit'");
                }
                break;
            case commit:
                if (getStream().getKeywords(false).isEmpty()) {
                    if (getStream().getKeywords(true).isEmpty()) {
                        System.err.println("Add at least one keyword with 'add'");
                    } else {
                        System.err.println("No keywords are available, the "
                                + "stream will stay open. Stop streaming with "
                                + "the 'close' command or add new keywords "
                                + "with 'add'.");
                    }
                } else {
                    getStream().commit();
                }
                break;
            case status:
                TweetCounter tc;
                tc = (TweetCounter) resultListeners.findListener(TweetCounter.class);
                if (stream_cached != null && getStream().isValid()) {
                    System.out.println("Streaming is active.");
                } else {
                    System.out.println("Streaming is inactive.");
                }
                System.out.println("Received tweets in session: " + tc.getTweetCount());
                System.out.println("Unique users: " + tc.getUsers().size());
                break;
            case close:
                safeClose();
                break;
            case help:
                for (String line : HELP) {
                    System.out.println(line);
                }
                for (Command cmd : Command.values()) {
                    System.out.printf("  %-10s", cmd.name());
                    if (!cmd.getDescription().isEmpty()) {
                        System.out.print(" " + cmd.getDescription());
                    }
                    if (cmd.getParamCount() == 1) {
                        System.out.print(" (1 arg)");
                    } else if (cmd.getParamCount() > 1) {
                        System.out.printf(" (%d args)", cmd.getParamCount());
                    }
                    System.out.println();
                }
                break;
            case exit:
                safeClose();
                throw new NoSuchElementException();
            case target:
                if (params.length > 0) {
                    // due to limitations of shell (does not handle escapes),
                    // do a manualy split as we cannot have spaces in our args.
                    if (params.length == 1) {
                        params = params[0].split("\\s+");
                    }
                    configureTargets(params);
                } else {
                    ClassEnabledTracker<ResultListener> targets;
                    targets = getPossibleTargets();
                    Set<String> enabledTargets = targets.getEnabled();
                    System.out.println("Possible targets (* = enabled):");
                    for (String name : targets.getNames()) {
                        System.out.print(" " + name);
                        if (enabledTargets.contains(name)) {
                            System.out.print("*");
                        }
                    }
                    System.out.println();
                }
                break;
            default:
                throw new AssertionError(command.name());
        }
    }

    private void safeClose() {
        if (stream_cached != null) {
            try {
                getStream().close();
            } catch (IOException ex) {
                // should not happen because getStream exists
                System.err.println("getStream().close() -- " + ex.getMessage());
            }
        }
        resultListeners.close();
    }

    /**
     * @return All targets that can be disabled or enabled.
     */
    private ClassEnabledTracker<ResultListener> getPossibleTargets() {
        Map<String, Class<? extends ResultListener>> targets = new TreeMap<>();
        targets.put("file", DataWriter.class);
        targets.put("cfile", CompressableDataWriter.class);
        targets.put("shell", StreamHandler.class);

        ClassEnabledTracker<ResultListener> targetFoo = new ClassEnabledTracker<>(targets);
        targetFoo.disableAll();
        targetFoo.enableClasses(resultListeners.getRegistered());
        return targetFoo;
    }

    /**
     * Process enable and disable target parameters.
     */
    private void configureTargets(String[] params) {
        ClassEnabledTracker<ResultListener> targets = getPossibleTargets();

        for (String type : params) {
            String name;
            // whether to remove, add targets or restrict to one
            if (type.startsWith("-") || type.startsWith("+")) {
                name = type.substring(1);
            } else {
                name = type;
            }
            if (!targets.has(name)) {
                System.err.println("Unrecognized target: " + name);
                continue;
            }
            // queue for enable or disable
            if (type.startsWith("-")) {
                targets.disable(name);
            } else if (type.startsWith("+")) {
                targets.enable(name);
            } else {
                targets.disableAll();
                targets.enable(name);
            }
        }
        for (String name : targets.getDisabled()) {
            if (disableTarget(targets.getClassByName(name))) {
                System.err.println("Disabled " + name);
            }
        }
        for (String name : targets.getEnabled()) {
            if (enableTarget(targets.getClassByName(name))) {
                System.err.println("Enabled " + name);
            }
        }
    }

    private boolean enableTarget(Class<? extends ResultListener> rlCls) {
        ResultListener oldListener = resultListeners.findListener(rlCls);

        // don't add it again if already activated
        if (oldListener != null) {
            return false;
        }

        if (DataWriter.class.isAssignableFrom(rlCls)) {
            Configuration config = Configuration.getConfig();

            String profilesFilename = config.getProperty(DataWriter.CFG_PROFILE_FILENAME);
            String tweetsFilename = config.getProperty(DataWriter.CFG_TWEETS_FILENAME);
            try {
                DataWriter dw;
                if (CompressableDataWriter.class.isAssignableFrom(rlCls)) {
                    // compressed stream, by default do not autoconvert
                    boolean convertUncompressed = Boolean.parseBoolean(
                            config.getProperty("force-gzip", "false"));
                    dw = new CompressableDataWriter(profilesFilename,
                            tweetsFilename, convertUncompressed);
                } else {
                    dw = new DataWriter(profilesFilename, tweetsFilename);
                }
                dw.open();
                resultListeners.register(dw);
                // save the changes to the config.
                config.save();
            } catch (IOException ex) {
                System.err.println("Could not open file for storing tweets:");
                System.err.println(ex.getMessage());
                return false;
            }
        } else if (rlCls == StreamHandler.class) {
            resultListeners.register(new StreamHandler());
        }
        return true;
    }

    private boolean disableTarget(Class<? extends ResultListener> rlCls) {
        ResultListener oldListener = resultListeners.findListener(rlCls);

        // no need for action if not activated
        if (oldListener == null) {
            return false;
        }

        resultListeners.unregister(oldListener);
        // do we need to cleanup something?
        if (oldListener instanceof Closeable) {
            IOUtils.closeQuietly((Closeable) oldListener);
        }
        return true;
    }
}