- tor-commits - lists.torproject.org

[tor/master] Add code to read all from a handle, but this block forever
by nickm＠torproject.org 30 Aug '11

30 Aug '11

commit 55a1cb53d6d1a8375afc12679b43901a977cf4b7 Author: Steven Murdoch <Steven.Murdoch(a)cl.cam.ac.uk> Date: Fri Jul 22 15:57:56 2011 +0100 Add code to read all from a handle, but this block forever See http://stackoverflow.com/questions/3722409/windows-child-process-with-redir… for a potential solution --- src/common/util.c | 56 +++++++++++++++++++++++++++++------------------- src/test/test-child.c | 18 +++++++++++++++ src/test/test_util.c | 24 +++++++++++++++++--- 3 files changed, 72 insertions(+), 26 deletions(-) diff --git a/src/common/util.c b/src/common/util.c index 3d39f59..e9b7909 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -3195,6 +3195,7 @@ tor_spawn_background(const char *const filename, const char **argv) /* Write the error message. GCC requires that we check the return value, but there is nothing we can do if it fails */ + // TODO: Don't use STDOUT, use a pipe set up just for this purpose nbytes = write(STDOUT_FILENO, error_message, error_message_length); nbytes = write(STDOUT_FILENO, hex_errno, sizeof(hex_errno)); @@ -3217,6 +3218,8 @@ tor_spawn_background(const char *const filename, const char **argv) return process_handle; } + // TODO: If the child process forked but failed to exec, waitpid it + /* Return read end of the pipes to caller, and close write end */ process_handle.stdout_pipe = stdout_pipe[0]; retval = close(stdout_pipe[1]); @@ -3281,22 +3284,41 @@ tor_get_exit_code(const process_handle_t process_handle) #endif // MS_WINDOWS } -ssize_t -tor_read_all_from_process_stdout(const process_handle_t process_handle, - char *buf, size_t count) -{ #ifdef MS_WINDOWS +/* Windows equivalent of read_all */ +static ssize_t +read_all_handle(HANDLE h, char *buf, size_t count) +{ + size_t numread = 0; BOOL retval; DWORD bytes_read; - retval = ReadFile(process_handle.stdout_pipe, buf, count, &bytes_read, NULL); - if (!retval) { - log_warn(LD_GENERAL, - "Failed to read from stdin pipe: %s", - format_win32_error(GetLastError())); + + if (count > SIZE_T_CEILING || count > SSIZE_T_MAX) return -1; - } else { - return bytes_read; + + while (numread != count) { + retval = ReadFile(h, buf+numread, count-numread, &bytes_read, NULL); + if (!retval) { + log_warn(LD_GENERAL, + "Failed to read from stdin pipe: %s", + format_win32_error(GetLastError())); + return -1; + } else if (0 == bytes_read) { + /* End of file */ + return bytes_read; + } + numread += bytes_read; } + return (ssize_t)numread; +} +#endif + +ssize_t +tor_read_all_from_process_stdout(const process_handle_t process_handle, + char *buf, size_t count) +{ +#ifdef MS_WINDOWS + return read_all_handle(process_handle.stdout_pipe, buf, count); #else return read_all(process_handle.stdout_pipe, buf, count, 0); #endif @@ -3307,17 +3329,7 @@ tor_read_all_from_process_stderr(const process_handle_t process_handle, char *buf, size_t count) { #ifdef MS_WINDOWS - BOOL retval; - DWORD bytes_read; - retval = ReadFile(process_handle.stderr_pipe, buf, count, &bytes_read, NULL); - if (!retval) { - log_warn(LD_GENERAL, - "Failed to read from stderr pipe: %s", - format_win32_error(GetLastError())); - return -1; - } else { - return bytes_read; - } + return read_all_handle(process_handle.stderr_pipe, buf, count); #else return read_all(process_handle.stderr_pipe, buf, count, 0); #endif diff --git a/src/test/test-child.c b/src/test/test-child.c index ca52750..cf49c5d 100644 --- a/src/test/test-child.c +++ b/src/test/test-child.c @@ -1,4 +1,11 @@ #include <stdio.h> +#include "orconfig.h" +#ifdef MS_WINDOWS +#define WINDOWS_LEAN_AND_MEAN +#include <windows.h> +#else +#include <unistd.h> +#endif /** Trivial test program which prints out its command line arguments so we can * check if tor_spawn_background() works */ @@ -11,7 +18,18 @@ main(int argc, char **argv) fprintf(stderr, "ERR\n"); for (i = 1; i < argc; i++) fprintf(stdout, "%s\n", argv[i]); + fprintf(stdout, "SLEEPING\n"); +#ifdef MS_WINDOWS + Sleep(1000); +#else + sleep(1); +#endif fprintf(stdout, "DONE\n"); +#ifdef MS_WINDOWS + Sleep(1000); +#else + sleep(1); +#endif return 0; } diff --git a/src/test/test_util.c b/src/test/test_util.c index 28030b7..63c8ad8 100644 --- a/src/test/test_util.c +++ b/src/test/test_util.c @@ -1379,7 +1379,8 @@ test_util_fgets_eagain(void *ptr) /** Helper function for testing tor_spawn_background */ static void run_util_spawn_background(const char *argv[], const char *expected_out, - const char *expected_err, int expected_exit) + const char *expected_err, int expected_exit, + int expected_status) { int retval; ssize_t pos; @@ -1389,7 +1390,12 @@ run_util_spawn_background(const char *argv[], const char *expected_out, /* Start the program */ process_handle = tor_spawn_background(argv[0], argv); - tt_int_op(process_handle.status, ==, 0); + tt_int_op(process_handle.status, ==, expected_status); + + /* If the process failed to start, don't bother continuing */ + if (process_handle.status == -1) + return; + tt_int_op(process_handle.stdout_pipe, >, 0); tt_int_op(process_handle.stderr_pipe, >, 0); @@ -1435,21 +1441,31 @@ test_util_spawn_background_ok(void *ptr) (void)ptr; - run_util_spawn_background(argv, expected_out, expected_err, 0); + run_util_spawn_background(argv, expected_out, expected_err, 0, 0); } /** Check that failing to find the executable works as expected */ static void test_util_spawn_background_fail(void *ptr) { +#ifdef MS_WINDOWS const char *argv[] = {BUILDDIR "/src/test/no-such-file", "--test", NULL}; const char *expected_out = "ERR: Failed to spawn background process " "- code 9/2\n"; const char *expected_err = ""; + const int expected_status = -1; +#else + const char *argv[] = {BUILDDIR "/src/test/no-such-file", "--test", NULL}; + const char *expected_out = "ERR: Failed to spawn background process " + "- code 9/2\n"; + const char *expected_err = ""; + // TODO: Once we can signal failure to exec, set this to be -1; + const int expected_status = 0; +#endif (void)ptr; - run_util_spawn_background(argv, expected_out, expected_err, 255); + run_util_spawn_background(argv, expected_out, expected_err, 255, expected_status); } static void

1 0

[tor/master] XXX Hack to allow tor-fw-helper to be built on Windows
by nickm＠torproject.org 30 Aug '11

30 Aug '11

commit 2eca0165945f4caddf0585f3f9a33e422f1deeb1 Author: Steven Murdoch <Steven.Murdoch(a)cl.cam.ac.uk> Date: Wed Jul 20 16:07:13 2011 +0100 XXX Hack to allow tor-fw-helper to be built on Windows For some reason, --with-libminiupnpc-dir doesn't work on Windows, so this hardcodes /local/lib as the path in which libminiupnpc.a can be found. Also, libminiupnpc needs libws2_32 and libiphlpapi under Windows, so this hardcodes these libraries when building the ./configure test program. These changes almost certainly break *nix, so should be fixed before merge. --- configure.in | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/configure.in b/configure.in index 0a01862..f111355 100644 --- a/configure.in +++ b/configure.in @@ -559,7 +559,7 @@ dnl There are no packages for Debian or Redhat as of this patch if test "$upnp" = "true"; then AC_DEFINE(MINIUPNPC, 1, [Define to 1 if we are building with UPnP.]) - TOR_SEARCH_LIBRARY(libminiupnpc, $trylibminiupnpcdir, [-lminiupnpc], + TOR_SEARCH_LIBRARY(libminiupnpc, $trylibminiupnpcdir, [-lminiupnpc -lws2_32 -liphlpapi], [#include <miniupnpc/miniwget.h> #include <miniupnpc/miniupnpc.h> #include <miniupnpc/upnpcommands.h>], @@ -567,7 +567,7 @@ if test "$upnp" = "true"; then const char * minissdpdsock, int sameport);], [upnpDiscover(1, 0, 0, 0); exit(0);], [--with-libminiupnpc-dir], - [/usr/lib/]) + [/local/lib/]) fi AC_SYS_LARGEFILE

1 0

[tor/master] XXX Use static linking on Windows because miniupnpc doesn't work as DLL
by nickm＠torproject.org 30 Aug '11

30 Aug '11

commit 0ea28ccea0034ef846b0600f9b683d3b341299e6 Author: Steven Murdoch <Steven.Murdoch(a)cl.cam.ac.uk> Date: Thu Jul 21 13:47:16 2011 +0100 XXX Use static linking on Windows because miniupnpc doesn't work as DLL --- src/tools/tor-fw-helper/tor-fw-helper-upnp.c | 1 + 1 files changed, 1 insertions(+), 0 deletions(-) diff --git a/src/tools/tor-fw-helper/tor-fw-helper-upnp.c b/src/tools/tor-fw-helper/tor-fw-helper-upnp.c index 18ca563..55bae11 100644 --- a/src/tools/tor-fw-helper/tor-fw-helper-upnp.c +++ b/src/tools/tor-fw-helper/tor-fw-helper-upnp.c @@ -9,6 +9,7 @@ #include "orconfig.h" #ifdef MINIUPNPC +#define STATICLIB #include <stdint.h> #include <string.h> #include <stdio.h>

1 0

[tor/master] XXX Link in libiphlpapi (should be disabled on non Win32 platforms)
by nickm＠torproject.org 30 Aug '11

30 Aug '11

commit 8db98c13b5cdc8eb11dfb593aea380334dc2ef7a Author: Steven Murdoch <Steven.Murdoch(a)cl.cam.ac.uk> Date: Thu Jul 21 13:47:58 2011 +0100 XXX Link in libiphlpapi (should be disabled on non Win32 platforms) --- src/tools/tor-fw-helper/Makefile.am | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/tools/tor-fw-helper/Makefile.am b/src/tools/tor-fw-helper/Makefile.am index 75878f2..05cea77 100644 --- a/src/tools/tor-fw-helper/Makefile.am +++ b/src/tools/tor-fw-helper/Makefile.am @@ -25,7 +25,7 @@ endif if MINIUPNPC miniupnpc_ldflags = @TOR_LDFLAGS_libminiupnpc@ -miniupnpc_ldadd = -lminiupnpc -lm +miniupnpc_ldadd = -lminiupnpc -lm -liphlpapi miniupnpc_cppflags = @TOR_CPPFLAGS_libminiupnpc@ else miniupnpc_ldflags =

1 0

[tor/master] Under Windows, call WSAStartup before using the network
by nickm＠torproject.org 30 Aug '11

30 Aug '11

commit 2002d4acdfac823c03cca3ed92de7f60b3272d86 Author: Steven Murdoch <Steven.Murdoch(a)cl.cam.ac.uk> Date: Thu Jul 21 14:14:57 2011 +0100 Under Windows, call WSAStartup before using the network --- src/tools/tor-fw-helper/tor-fw-helper.c | 33 ++++++++++++++++++++++++++++++- 1 files changed, 32 insertions(+), 1 deletions(-) diff --git a/src/tools/tor-fw-helper/tor-fw-helper.c b/src/tools/tor-fw-helper/tor-fw-helper.c index 20d60d7..926fa61 100644 --- a/src/tools/tor-fw-helper/tor-fw-helper.c +++ b/src/tools/tor-fw-helper/tor-fw-helper.c @@ -13,6 +13,7 @@ * later date. */ +#include "orconfig.h" #include <stdio.h> #include <stdint.h> #include <stdlib.h> @@ -20,7 +21,10 @@ #include <time.h> #include <string.h> -#include "orconfig.h" +#ifdef MS_WINDOWS +#include <winsock2.h> +#endif + #include "tor-fw-helper.h" #ifdef NAT_PMP #include "tor-fw-helper-natpmp.h" @@ -219,6 +223,29 @@ tor_fw_add_dir_port(tor_fw_options_t *tor_fw_options, } } +/** Called before we make any calls to network-related functions. + * (Some operating systems require their network libraries to be + * initialized.) (from common/compat.c) */ +static int +network_init(void) +{ +#ifdef MS_WINDOWS + /* This silly exercise is necessary before windows will allow + * gethostbyname to work. */ + WSADATA WSAData; + int r; + r = WSAStartup(0x101, &WSAData); + if (r) { + fprintf(stderr, "E: Error initializing Windows network layer - code was %d", r); + return -1; + } + /* WSAData.iMaxSockets might show the max sockets we're allowed to use. + * We might use it to complain if we're trying to be a server but have + * too few sockets available. */ +#endif + return 0; +} + int main(int argc, char **argv) { @@ -329,6 +356,10 @@ main(int argc, char **argv) tor_fw_options.public_dir_port); } + // Initialize networking + if (network_init()) + exit(1); + // Initalize the various fw-helper backend helpers r = init_backends(&tor_fw_options, &backend_state); if (r)

1 0

[tor/master] Generalize process spawning so its test compiles (but fails) in Windows
by nickm＠torproject.org 30 Aug '11

30 Aug '11

commit 35c89be02b535e2951b695429bd9b255afb2a7b2 Author: Steven Murdoch <Steven.Murdoch(a)cl.cam.ac.uk> Date: Thu Jul 21 16:34:48 2011 +0100 Generalize process spawning so its test compiles (but fails) in Windows - pid, stdout/stderr_pipe now encapsulated in process_handle - read_all replaced by tor_read_all_from_process_stdin/stderr - waitpid replaced by tor_get_exit_code Untested on *nix --- src/common/util.c | 78 ++++++++++++++++++++++++++++++++++++++++++-------- src/common/util.h | 23 +++++++++++++- src/test/test_util.c | 33 +++++++++------------ 3 files changed, 101 insertions(+), 33 deletions(-) diff --git a/src/common/util.c b/src/common/util.c index b95ee3a..5bc7a80 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -2978,14 +2978,15 @@ format_helper_exit_status(unsigned char child_state, int saved_errno, * -1. Some parts of this code are based on the POSIX subprocess module from * Python. */ -int -tor_spawn_background(const char *const filename, int *stdout_read, - int *stderr_read, const char **argv) +process_handle_t +tor_spawn_background(const char *const filename, const char **argv) { + process_handle_t process_handle; #ifdef MS_WINDOWS - (void) filename; (void) stdout_read; (void) stderr_read; (void) argv; + (void) filename; (void) argv; log_warn(LD_BUG, "not yet implemented on Windows."); - return -1; + process_handle.status = -1; + return process_handle; #else pid_t pid; int stdout_pipe[2]; @@ -3016,7 +3017,8 @@ tor_spawn_background(const char *const filename, int *stdout_read, log_warn(LD_GENERAL, "Failed to set up pipe for stdout communication with child process: %s", strerror(errno)); - return -1; + process_handle.status = -1; + return process_handle; } retval = pipe(stderr_pipe); @@ -3024,7 +3026,8 @@ tor_spawn_background(const char *const filename, int *stdout_read, log_warn(LD_GENERAL, "Failed to set up pipe for stderr communication with child process: %s", strerror(errno)); - return -1; + process_handle.status = -1; + return process_handle; } child_state = CHILD_STATE_MAXFD; @@ -3109,7 +3112,8 @@ tor_spawn_background(const char *const filename, int *stdout_read, (void) nbytes; _exit(255); - return -1; /* Never reached, but avoids compiler warning */ + process_handle.status = -1; + return process_handle; /* Never reached, but avoids compiler warning */ } /* In parent */ @@ -3120,11 +3124,12 @@ tor_spawn_background(const char *const filename, int *stdout_read, close(stdout_pipe[1]); close(stderr_pipe[0]); close(stderr_pipe[1]); - return -1; + process_handle.status = -1; + return process_handle; } /* Return read end of the pipes to caller, and close write end */ - *stdout_read = stdout_pipe[0]; + process_handle.stdout_pipe = stdout_pipe[0]; retval = close(stdout_pipe[1]); if (-1 == retval) { @@ -3135,7 +3140,7 @@ tor_spawn_background(const char *const filename, int *stdout_read, needs to know about the pid in order to reap it later */ } - *stderr_read = stderr_pipe[0]; + process_handle.stderr_pipe = stderr_pipe[0]; retval = close(stderr_pipe[1]); if (-1 == retval) { @@ -3146,7 +3151,56 @@ tor_spawn_background(const char *const filename, int *stdout_read, needs to know about the pid in order to reap it later */ } - return pid; + process_handle.status = 0; + process_handle.pid = pid; + return process_handle; +#endif +} + +int +tor_get_exit_code(const process_handle_t process_handle) +{ +#ifdef MS_WINDOWS + log_warn(LD_BUG, "not yet implemented on Windows."); + return -1; +#else + int stat_loc; + + retval = waitpid(process_handle.pid, &stat_loc, 0); + if (retval != process_handle.pid) { + log_warn(LD_GENERAL, "waitpid() failed for PID %d: %s", process_handle.pid, + sterror(errno)); + return -1; + } + + if (!WIFEXITED(stat_loc)) { + log_warn(LD_GENERAL, "Process %d did not exit normally", process_handle.pid); + return -1; + } + + return WEXITSTATUS(stat_loc); +#endif // MS_WINDOWS +} + +ssize_t +tor_read_all_from_process_stdin(const process_handle_t process_handle, + char *buf, size_t count) +{ +#ifdef MS_WINDOWS + return -1; +#else + return read_all(process_handle.stdin_pipe, buf, count, 0); +#endif +} + +ssize_t +tor_read_all_from_process_stderr(const process_handle_t process_handle, + char *buf, size_t count) +{ +#ifdef MS_WINDOWS + return -1; +#else + return read_all(process_handle.stderr_pipe, buf, count, 0); #endif } diff --git a/src/common/util.h b/src/common/util.h index 6496c42..2cf57a1 100644 --- a/src/common/util.h +++ b/src/common/util.h @@ -347,8 +347,27 @@ HANDLE load_windows_system_library(const TCHAR *library_name); #ifdef UTIL_PRIVATE /* Prototypes for private functions only used by util.c (and unit tests) */ -int tor_spawn_background(const char *const filename, int *stdout_read, - int *stderr_read, const char **argv); + +typedef struct process_handle_s { + int status; +#ifdef MS_WINDOWS + HANDLE stdout_pipe; + HANDLE stderr_pipe; + HANDLE pid; +#else + int stdout_pipe; + int stderr_pipe; + int pid; +#endif // MS_WINDOWS +} process_handle_t; + +process_handle_t tor_spawn_background(const char *const filename, + const char **argv); +int tor_get_exit_code(const process_handle_t pid); +ssize_t tor_read_all_from_process_stdin(const process_handle_t process_handle, + char *buf, size_t count); +ssize_t tor_read_all_from_process_stderr(const process_handle_t process_handle, + char *buf, size_t count); void format_helper_exit_status(unsigned char child_state, int saved_errno, char *hex_errno); diff --git a/src/test/test_util.c b/src/test/test_util.c index c4769e6..fce53b8 100644 --- a/src/test/test_util.c +++ b/src/test/test_util.c @@ -1376,42 +1376,38 @@ test_util_fgets_eagain(void *ptr) } #endif -#ifndef MS_WINDOWS /** Helper function for testing tor_spawn_background */ static void run_util_spawn_background(const char *argv[], const char *expected_out, const char *expected_err, int expected_exit) { - int stdout_pipe=-1, stderr_pipe=-1; - int retval, stat_loc; - pid_t pid; + int retval; ssize_t pos; + process_handle_t process_handle; char stdout_buf[100], stderr_buf[100]; /* Start the program */ - retval = tor_spawn_background(argv[0], &stdout_pipe, &stderr_pipe, argv); - tt_int_op(retval, >, 0); - tt_int_op(stdout_pipe, >, 0); - tt_int_op(stderr_pipe, >, 0); - pid = retval; + process_handle = tor_spawn_background(argv[0], argv); + + tt_int_op(process_handle.status, ==, 0); + tt_int_op(process_handle.stdout_pipe, >, 0); + tt_int_op(process_handle.stderr_pipe, >, 0); /* Check stdout */ - pos = read_all(stdout_pipe, stdout_buf, sizeof(stdout_buf) - 1, 0); + pos = tor_read_all_from_process_stdin(process_handle, stdout_buf, + sizeof(stdout_buf) - 1); tt_assert(pos >= 0); stdout_buf[pos] = '\0'; tt_int_op(pos, ==, strlen(expected_out)); tt_str_op(stdout_buf, ==, expected_out); /* Check it terminated correctly */ - retval = waitpid(pid, &stat_loc, 0); - tt_int_op(retval, ==, pid); - tt_assert(WIFEXITED(stat_loc)); - tt_int_op(WEXITSTATUS(stat_loc), ==, expected_exit); - tt_assert(!WIFSIGNALED(stat_loc)); - tt_assert(!WIFSTOPPED(stat_loc)); + retval = tor_get_exit_code(process_handle); + tt_int_op(retval, ==, expected_exit); /* Check stderr */ - pos = read_all(stderr_pipe, stderr_buf, sizeof(stderr_buf) - 1, 0); + pos = tor_read_all_from_process_stderr(process_handle, stderr_buf, + sizeof(stderr_buf) - 1); tt_assert(pos >= 0); stderr_buf[pos] = '\0'; tt_int_op(pos, ==, strlen(expected_err)); @@ -1447,7 +1443,6 @@ test_util_spawn_background_fail(void *ptr) run_util_spawn_background(argv, expected_out, expected_err, 255); } -#endif static void test_util_di_ops(void) @@ -1533,9 +1528,9 @@ struct testcase_t util_tests[] = { UTIL_TEST(exit_status, 0), #ifndef MS_WINDOWS UTIL_TEST(fgets_eagain, TT_SKIP), +#endif UTIL_TEST(spawn_background_ok, 0), UTIL_TEST(spawn_background_fail, 0), -#endif END_OF_TESTCASES };

1 0

[arm/master] Class and formatting interpretor refactoring
by atagar＠torproject.org 30 Aug '11

30 Aug '11

commit c8d21d593887bb537c144b71f15c7ed38f1880ed Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Aug 29 09:50:15 2011 -0700 Class and formatting interpretor refactoring This moves around the interpretor code a bit to allow for arbitrary attribute drawing and introduce an interpretor class (needed for when implementing the '/write' option). --- src/cli/interpretorPanel.py | 41 +++++---- src/util/torInterpretor.py | 191 ++++++++++++++++++++++--------------------- 2 files changed, 121 insertions(+), 111 deletions(-) diff --git a/src/cli/interpretorPanel.py b/src/cli/interpretorPanel.py index 95866db..02868ce 100644 --- a/src/cli/interpretorPanel.py +++ b/src/cli/interpretorPanel.py @@ -8,7 +8,7 @@ import curses from util import panel, textInput, torInterpretor, uiTools USAGE_INFO = "to use this panel press enter" -PROMPT_LINE = [(torInterpretor.PROMPT, torInterpretor.Formats.PROMPT), (USAGE_INFO, torInterpretor.Formats.USAGE)] +PROMPT_LINE = [torInterpretor.PROMPT, (USAGE_INFO, torInterpretor.USAGE_FORMAT)] # limits used for cropping BACKLOG_LIMIT = 100 @@ -17,34 +17,37 @@ LINES_LIMIT = 2000 # lazy loaded curses formatting constants FORMATS = {} -def getFormat(format): +def getFormat(formatAttr): """ - Provides the curses drawing attributes for a torInterpretor.Formats enum. - This returns plain formatting if the entry doesn't exist. + Provides the curses drawing attributes for torInterpretor formatting + attributes. Arguments: - format - format enum to fetch + formatAttr - list of formatting attributes """ # initializes formats if they haven't yet been loaded if not FORMATS: - FORMATS[torInterpretor.Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") - FORMATS[torInterpretor.Formats.INPUT] = uiTools.getColor("cyan") - FORMATS[torInterpretor.Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") - FORMATS[torInterpretor.Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") - FORMATS[torInterpretor.Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") - FORMATS[torInterpretor.Formats.OUTPUT] = uiTools.getColor("blue") - FORMATS[torInterpretor.Formats.USAGE] = uiTools.getColor("cyan") - FORMATS[torInterpretor.Formats.HELP] = uiTools.getColor("magenta") - FORMATS[torInterpretor.Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") + for colorEnum in torInterpretor.Color.values(): + FORMATS[colorEnum] = uiTools.getColor(colorEnum.lower()) + + FORMATS[torInterpretor.Attr.BOLD] = curses.A_BOLD + FORMATS[torInterpretor.Attr.UNDERLINE] = curses.A_UNDERLINE + FORMATS[torInterpretor.Attr.HILIGHT] = curses.A_STANDOUT + + cursesFormatting = curses.A_NORMAL + + for attr in formatAttr: + cursesFormatting |= FORMATS.get(attr, curses.A_NORMAL) - return FORMATS.get(format, curses.A_NORMAL) + return cursesFormatting class InterpretorPanel(panel.Panel): def __init__(self, stdscr): panel.Panel.__init__(self, stdscr, "interpretor", 0) self.isInputMode = False self.scroll = 0 + self.interpretor = torInterpretor.ControlInterpretor() self.previousCommands = [] # user input, newest to oldest self.contents = [PROMPT_LINE] # (msg, format enum) tuples being displayed (oldest to newest) @@ -61,18 +64,18 @@ class InterpretorPanel(panel.Panel): self.redraw(True) # intercepts input so user can cycle through the history - torCommands = torInterpretor.TorCommandOptions() + torCommands = torInterpretor.TorControlCompleter() validator = textInput.BasicValidator() validator = textInput.HistoryValidator(self.previousCommands, validator) validator = textInput.TabCompleter(torCommands.getMatches, validator) - xOffset = len(torInterpretor.PROMPT) + xOffset = len(torInterpretor.PROMPT[0]) if len(self.contents) > self.maxY - 1: xOffset += 3 # offset for scrollbar inputLine = min(self.maxY - 1, len(self.contents)) - inputFormat = getFormat(torInterpretor.Formats.INPUT) + inputFormat = getFormat(torInterpretor.INPUT_FORMAT) input = self.getstr(inputLine, xOffset, "", inputFormat, validator = validator) input, isDone = input.strip(), False @@ -84,7 +87,7 @@ class InterpretorPanel(panel.Panel): self.previousCommands = self.previousCommands[:BACKLOG_LIMIT] try: - inputEntry, outputEntry = torInterpretor.handleQuery(input) + inputEntry, outputEntry = self.interpretor.handleQuery(input) except torInterpretor.InterpretorClosed: isDone = True diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index cffe200..c7bcebb 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -8,9 +8,6 @@ import readline # simply importing this provides history to raw_input from util import enum, torTools -PROMPT = ">>> " -Formats = enum.Enum("PROMPT", "INPUT", "INPUT_INTERPRETOR", "INPUT_CMD", "INPUT_ARG", "OUTPUT", "USAGE", "HELP", "ERROR") - TERM_COLORS = ("BLACK", "RED", "GREEN", "YELLOW", "BLUE", "MAGENTA", "CYAN", "WHITE") Color = enum.Enum(*TERM_COLORS) @@ -21,6 +18,16 @@ FG_ENCODING = dict([(Color.values()[i], str(30 + i)) for i in range(8)]) BG_ENCODING = dict([(BgColor.values()[i], str(40 + i)) for i in range(8)]) ATTR_ENCODING = {Attr.BOLD: "1", Attr.UNDERLINE: "4", Attr.HILIGHT: "7"} +PROMPT = (">>> ", (Attr.BOLD, Color.GREEN)) +INPUT_FORMAT = (Color.CYAN, ) +INPUT_INTERPRETOR_FORMAT = (Attr.BOLD, Color.MAGENTA) +INPUT_CMD_FORMAT = (Attr.BOLD, Color.GREEN) +INPUT_ARG_FORMAT = (Attr.BOLD, Color.CYAN) +OUTPUT_FORMAT = (Color.BLUE, ) +USAGE_FORMAT = (Color.CYAN, ) +HELP_FORMAT = (Color.MAGENTA, ) +ERROR_FORMAT = (Attr.BOLD, Color.RED) + CSI = "\x1B[%sm" RESET = CSI % "0" @@ -64,7 +71,7 @@ def format(msg, *attr): return (CSI % ";".join(encodings)) + msg + RESET else: return msg -class TorCommandOptions: +class TorControlCompleter: """ Command autocompleter, fetching the valid options from the attached Tor instance. @@ -169,12 +176,96 @@ class TorCommandOptions: if not state: return cmd else: state -= 1 +class ControlInterpretor: + """ + Interpretor that handles queries to the control port, providing usability + imporvements like irc style help optoins. This tracks input and responses. + """ + + def __init__(self): + self.queries = [] # requests made, newest to oldest + self.contents = [] # (msg, format list) tuples of both input and output (oldest to newest) + + def handleQuery(self, input): + """ + Processes the given input. Requests starting with a '/' are special + commands to the interpretor, and anything else is sent to the control port. + This returns an input/output tuple, each entry being a list of lines, each + line having a list of (msg, format) tuples for the content to be displayed. + This raises a InterpretorClosed if the interpretor should be shut down. + + Arguments: + input - user input to be processed + """ + + input = input.strip() + inputEntry, outputEntry = [PROMPT], [] + conn = torTools.getConn() + + # input falls into three general categories: + # - interpretor command which starts with a '/' + # - controller commands handled by torTools (this allows for caching, + # proper handling by the rest of arm, etc) + # - unrecognized controller command, this has the possability of confusing + # arm... + + if input.startswith("/"): + # interpretor command + inputEntry.append((input, INPUT_INTERPRETOR_FORMAT)) + outputEntry.append(("Not yet implemented...", ERROR_FORMAT)) # TODO: implement + + # TODO: add /help option + # TODO: add /write option + else: + # controller command + if " " in input: cmd, arg = input.split(" ", 1) + else: cmd, arg = input, "" + + # makes commands uppercase to match the spec + cmd = cmd.upper() + + inputEntry.append((cmd + " ", INPUT_CMD_FORMAT)) + if arg: inputEntry.append((arg, INPUT_ARG_FORMAT)) + + if cmd == "GETINFO": + try: + response = conn.getInfo(arg, suppressExc = False) + outputEntry.append((response, OUTPUT_FORMAT)) + except Exception, exc: + outputEntry.append((str(exc), ERROR_FORMAT)) + elif cmd == "SETCONF": + if "=" in arg: + param, value = arg.split("=", 1) + + try: + conn.setOption(param.strip(), value.strip()) + except Exception, exc: + outputEntry.append((str(exc), ERROR_FORMAT)) + else: + # TODO: resets the attribute + outputEntry.append(("Not yet implemented...", ERROR_FORMAT)) # TODO: implement + else: + try: + response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) + + for entry in response: + # Response entries are tuples with the response code, body, and + # extra info. For instance: + # ('250', 'version=0.2.2.23-alpha (git-b85eb949b528f4d7)', None) + + if len(entry) == 3: + outputEntry.append((entry[1], OUTPUT_FORMAT)) + except Exception, exc: + outputEntry.append((str(exc), ERROR_FORMAT)) + + return (_splitOnNewlines(inputEntry), _splitOnNewlines(outputEntry)) + def prompt(): prompt = format(">>> ", Color.GREEN, Attr.BOLD) input = "" # sets up tab autocompetion - torCommands = TorCommandOptions() + torCommands = TorControlCompleter() readline.parse_and_bind("tab: complete") readline.set_completer(torCommands.complete) @@ -184,17 +275,7 @@ def prompt(): # command by itself. readline.set_completer_delims("\n") - - formatMap = {} # mapping of Format to Color and Attr enums - formatMap[Formats.PROMPT] = (Attr.BOLD, Color.GREEN) - formatMap[Formats.INPUT] = (Color.CYAN, ) - formatMap[Formats.INPUT_INTERPRETOR] = (Attr.BOLD, Color.MAGENTA) - formatMap[Formats.INPUT_CMD] = (Attr.BOLD, Color.GREEN) - formatMap[Formats.INPUT_ARG] = (Attr.BOLD, Color.CYAN) - formatMap[Formats.OUTPUT] = (Color.BLUE, ) - formatMap[Formats.USAGE] = (Color.CYAN, ) - formatMap[Formats.HELP] = (Color.MAGENTA, ) - formatMap[Formats.ERROR] = (Attr.BOLD, Color.RED) + interpretor = ControlInterpretor() while input != "/quit": try: @@ -205,90 +286,16 @@ def prompt(): print break - _, outputEntry = handleQuery(input) + _, outputEntry = interpretor.handleQuery(input) for line in outputEntry: outputLine = "" for msg, msgFormat in line: - outputLine += format(msg, *formatMap[msgFormat]) + outputLine += format(msg, *msgFormat) print outputLine -def handleQuery(input): - """ - Processes the given input. Requests starting with a '/' are special - commands to the interpretor, and anything else is sent to the control port. - This returns an input/output tuple, each entry being a list of lines, each - line having a list of (msg, format) tuples for the content to be displayed. - This raises a InterpretorClosed if the interpretor should be shut down. - - Arguments: - input - user input to be processed - """ - - input = input.strip() - inputEntry, outputEntry = [(PROMPT, Formats.PROMPT)], [] - conn = torTools.getConn() - - # input falls into three general categories: - # - interpretor command which starts with a '/' - # - controller commands handled by torTools (this allows for caching, - # proper handling by the rest of arm, etc) - # - unrecognized controller command, this has the possability of confusing - # arm... - - if input.startswith("/"): - # interpretor command - inputEntry.append((input, Formats.INPUT_INTERPRETOR)) - outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement - - # TODO: add /help option - # TODO: add /write option - else: - # controller command - if " " in input: cmd, arg = input.split(" ", 1) - else: cmd, arg = input, "" - - # makes commands uppercase to match the spec - cmd = cmd.upper() - - inputEntry.append((cmd + " ", Formats.INPUT_CMD)) - if arg: inputEntry.append((arg, Formats.INPUT_ARG)) - - if cmd == "GETINFO": - try: - response = conn.getInfo(arg, suppressExc = False) - outputEntry.append((response, Formats.OUTPUT)) - except Exception, exc: - outputEntry.append((str(exc), Formats.ERROR)) - elif cmd == "SETCONF": - if "=" in arg: - param, value = arg.split("=", 1) - - try: - conn.setOption(param.strip(), value.strip()) - except Exception, exc: - outputEntry.append((str(exc), Formats.ERROR)) - else: - # TODO: resets the attribute - outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement - else: - try: - response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) - - for entry in response: - # Response entries are tuples with the response code, body, and - # extra info. For instance: - # ('250', 'version=0.2.2.23-alpha (git-b85eb949b528f4d7)', None) - - if len(entry) == 3: - outputEntry.append((entry[1], Formats.OUTPUT)) - except Exception, exc: - outputEntry.append((str(exc), Formats.ERROR)) - - return (_splitOnNewlines(inputEntry), _splitOnNewlines(outputEntry)) - def _splitOnNewlines(entry): """ Splits a list of (msg, format) tuples on newlines into a list of lines.

1 0

[arm/master] Moving content and backlog tracking to interpretor
by atagar＠torproject.org 30 Aug '11

30 Aug '11

commit 59b70998b162c461ec03780e9ca4cabdb7411af4 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Aug 30 09:41:53 2011 -0700 Moving content and backlog tracking to interpretor The interpretor class will be tracking state so moving this information to it from the panel. This will make a common saving function feasable. --- src/cli/interpretorPanel.py | 49 +++++++++++----------------------- src/util/torInterpretor.py | 60 +++++++++++++++++++++++++++++++++++-------- 2 files changed, 65 insertions(+), 44 deletions(-) diff --git a/src/cli/interpretorPanel.py b/src/cli/interpretorPanel.py index 02868ce..cc8b496 100644 --- a/src/cli/interpretorPanel.py +++ b/src/cli/interpretorPanel.py @@ -10,17 +10,12 @@ from util import panel, textInput, torInterpretor, uiTools USAGE_INFO = "to use this panel press enter" PROMPT_LINE = [torInterpretor.PROMPT, (USAGE_INFO, torInterpretor.USAGE_FORMAT)] -# limits used for cropping -BACKLOG_LIMIT = 100 -LINES_LIMIT = 2000 - -# lazy loaded curses formatting constants +# lazy loaded mapping of interpretor attributes to curses formatting constants FORMATS = {} def getFormat(formatAttr): """ - Provides the curses drawing attributes for torInterpretor formatting - attributes. + Provides the curses drawing attributes for torInterpretor formats. Arguments: formatAttr - list of formatting attributes @@ -45,11 +40,10 @@ def getFormat(formatAttr): class InterpretorPanel(panel.Panel): def __init__(self, stdscr): panel.Panel.__init__(self, stdscr, "interpretor", 0) + self.interpretor = torInterpretor.ControlInterpretor() + self.inputCompleter = torInterpretor.TorControlCompleter() self.isInputMode = False self.scroll = 0 - self.interpretor = torInterpretor.ControlInterpretor() - self.previousCommands = [] # user input, newest to oldest - self.contents = [PROMPT_LINE] # (msg, format enum) tuples being displayed (oldest to newest) def prompt(self): """ @@ -64,17 +58,16 @@ class InterpretorPanel(panel.Panel): self.redraw(True) # intercepts input so user can cycle through the history - torCommands = torInterpretor.TorControlCompleter() - validator = textInput.BasicValidator() - validator = textInput.HistoryValidator(self.previousCommands, validator) - validator = textInput.TabCompleter(torCommands.getMatches, validator) + validator = textInput.HistoryValidator(list(reversed(self.interpretor.getBacklog())), validator) + validator = textInput.TabCompleter(self.inputCompleter.getMatches, validator) xOffset = len(torInterpretor.PROMPT[0]) - if len(self.contents) > self.maxY - 1: + displayLength = len(self.interpretor.getDisplayContents(PROMPT_LINE)) + if displayLength > self.maxY - 1: xOffset += 3 # offset for scrollbar - inputLine = min(self.maxY - 1, len(self.contents)) + inputLine = min(self.maxY - 1, displayLength) inputFormat = getFormat(torInterpretor.INPUT_FORMAT) input = self.getstr(inputLine, xOffset, "", inputFormat, validator = validator) input, isDone = input.strip(), False @@ -83,22 +76,10 @@ class InterpretorPanel(panel.Panel): # terminate input when we get a blank line isDone = True else: - self.previousCommands.insert(0, input) - self.previousCommands = self.previousCommands[:BACKLOG_LIMIT] - try: inputEntry, outputEntry = self.interpretor.handleQuery(input) except torInterpretor.InterpretorClosed: isDone = True - - promptEntry = self.contents.pop() # removes old prompt entry - self.contents += inputEntry - self.contents += outputEntry - self.contents.append(promptEntry) - - # if too long then crop lines - cropLines = len(self.contents) - LINES_LIMIT - if cropLines > 0: self.contents = self.contents[cropLines:] if isDone: self.isInputMode = False @@ -112,7 +93,8 @@ class InterpretorPanel(panel.Panel): self.prompt() elif uiTools.isScrollKey(key) and not self.isInputMode: pageHeight = self.getPreferredSize()[0] - 1 - newScroll = uiTools.getScrollPosition(key, self.scroll, pageHeight, len(self.contents)) + displayLength = len(self.interpretor.getDisplayContents(PROMPT_LINE)) + newScroll = uiTools.getScrollPosition(key, self.scroll, pageHeight, displayLength) if self.scroll != newScroll: self.scroll = newScroll @@ -127,17 +109,18 @@ class InterpretorPanel(panel.Panel): self.addstr(0, 0, "Control Interpretor%s:" % usageMsg, curses.A_STANDOUT) xOffset = 0 - if len(self.contents) > height - 1: + displayContents = self.interpretor.getDisplayContents(PROMPT_LINE) + if len(displayContents) > height - 1: # if we're in input mode then make sure the last line is visible if self.isInputMode: - self.scroll = len(self.contents) - height + 1 + self.scroll = len(displayContents) - height + 1 xOffset = 3 - self.addScrollBar(self.scroll, self.scroll + height - 1, len(self.contents), 1) + self.addScrollBar(self.scroll, self.scroll + height - 1, len(displayContents), 1) # draws prior commands and output drawLine = 1 - for entry in self.contents[self.scroll:]: + for entry in displayContents[self.scroll:]: cursor = xOffset for msg, formatEntry in entry: diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index c7bcebb..e062532 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -31,6 +31,10 @@ ERROR_FORMAT = (Attr.BOLD, Color.RED) CSI = "\x1B[%sm" RESET = CSI % "0" +# limits used for cropping +BACKLOG_LIMIT = 100 +CONTENT_LIMIT = 2000 + class InterpretorClosed(Exception): """ Exception raised when the interpretor should be shut down. @@ -92,11 +96,10 @@ class TorControlCompleter: if line.startswith("config/*") or line.startswith("dir-usage"): continue - # strips off the ending asterisk if it accepts a value infoOpt = line.split(" ", 1)[0] - if infoOpt.endswith("*"): - infoOpt = infoOpt[:-1] + # strips off the ending asterisk if it accepts a value + if infoOpt.endswith("*"): infoOpt = infoOpt[:-1] self.commands.append("GETINFO %s" % infoOpt) else: self.commands.append("GETINFO ") @@ -157,7 +160,7 @@ class TorControlCompleter: def getMatches(self, text): """ - Provides all options that match the given input. + Provides all options that match the given input. This is case insensetive. Arguments: text - user input text to be matched against @@ -171,10 +174,9 @@ class TorControlCompleter: the readlines set_completer function. """ - for cmd in self.commands: - if cmd.lower().startswith(text.lower()): - if not state: return cmd - else: state -= 1 + for cmd in self.getMatches(text): + if not state: return cmd + else: state -= 1 class ControlInterpretor: """ @@ -183,8 +185,29 @@ class ControlInterpretor: """ def __init__(self): - self.queries = [] # requests made, newest to oldest - self.contents = [] # (msg, format list) tuples of both input and output (oldest to newest) + self.backlog = [] # prior requests the user has made + self.contents = [] # (msg, format list) tuples for what's been displayed + + def getBacklog(self): + """ + Provides the backlog of prior user input. + """ + + return self.backlog + + def getDisplayContents(self, appendPrompt = None): + """ + Provides a list of lines to be displayed, each being a list of (msg, + format) tuples for the content to be displayed. This is ordered as the + oldest to newest. + + Arguments: + appendPrompt - adds the given line to the end + """ + + if appendPrompt: + return self.contents + [appendPrompt] + else: return self.contents def handleQuery(self, input): """ @@ -199,6 +222,12 @@ class ControlInterpretor: """ input = input.strip() + + # appends new input, cropping if too long + self.backlog.append(input) + backlogCrop = len(self.backlog) - BACKLOG_LIMIT + if backlogCrop > 0: self.backlog = self.backlog[backlogCrop:] + inputEntry, outputEntry = [PROMPT], [] conn = torTools.getConn() @@ -258,7 +287,16 @@ class ControlInterpretor: except Exception, exc: outputEntry.append((str(exc), ERROR_FORMAT)) - return (_splitOnNewlines(inputEntry), _splitOnNewlines(outputEntry)) + # converts to lists split on newlines + inputLines = _splitOnNewlines(inputEntry) + outputLines = _splitOnNewlines(outputEntry) + + # appends new contents, cropping if too long + self.contents += inputLines + outputLines + cropLines = len(self.contents) - CONTENT_LIMIT + if cropLines > 0: self.contents = self.contents[cropLines:] + + return (inputLines, outputLines) def prompt(): prompt = format(">>> ", Color.GREEN, Attr.BOLD)

1 0

[arm/master] Implementing /quit option
by atagar＠torproject.org 30 Aug '11

30 Aug '11

commit 8f4e5b819302db174881fa0d630cf0d0c31ce942 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Aug 30 09:49:45 2011 -0700 Implementing /quit option --- src/util/torInterpretor.py | 11 +++++++---- 1 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index e062532..d73e84f 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -241,7 +241,11 @@ class ControlInterpretor: if input.startswith("/"): # interpretor command inputEntry.append((input, INPUT_INTERPRETOR_FORMAT)) - outputEntry.append(("Not yet implemented...", ERROR_FORMAT)) # TODO: implement + + if input == "/quit": + raise InterpretorClosed() + else: + outputEntry.append(("Not yet implemented...", ERROR_FORMAT)) # TODO: implement # TODO: add /help option # TODO: add /write option @@ -315,17 +319,16 @@ def prompt(): readline.set_completer_delims("\n") interpretor = ControlInterpretor() - while input != "/quit": + while True: try: input = raw_input(prompt) + _, outputEntry = interpretor.handleQuery(input) except: # moves cursor to the next line and terminates (most commonly # KeyboardInterrupt and EOFErro) print break - _, outputEntry = interpretor.handleQuery(input) - for line in outputEntry: outputLine = ""

1 0

[arm/master] Providing a startup message for interpretor prompt
by atagar＠torproject.org 30 Aug '11

30 Aug '11

commit ad5afa2a945a36a6b1b04e78a91e83876a77301a Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Aug 30 09:57:31 2011 -0700 Providing a startup message for interpretor prompt Simple message giving arm's version and mentoining the /help and /quit options. --- src/util/torInterpretor.py | 8 ++++++++ 1 files changed, 8 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index d73e84f..266e9e4 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -6,8 +6,14 @@ directly, history and tab completion. import readline # simply importing this provides history to raw_input +import version + from util import enum, torTools +INIT_MSG = """Arm %s Control Interpretor +Enter \"/help\" for usage information and \"/quit\" to stop. +""" % version.VERSION + TERM_COLORS = ("BLACK", "RED", "GREEN", "YELLOW", "BLUE", "MAGENTA", "CYAN", "WHITE") Color = enum.Enum(*TERM_COLORS) @@ -319,6 +325,8 @@ def prompt(): readline.set_completer_delims("\n") interpretor = ControlInterpretor() + print INIT_MSG + while True: try: input = raw_input(prompt)

1 0